Swift3:设置Finder标签颜色

Swift 3: Set Finder label color

我正在尝试设置取景器显示的彩色标签。我知道的唯一函数是 setResourceValue。但这需要本地化名称!

我还可以想象我的母语和英语,但我不知道所有其他语言。我不敢相信,这应该是方式。

是翻译函数吗,它采用标准参数(如枚举或整数)并提供本地化的颜色名称?

我有一个 运行 部分,但只有两种语言(德语和英语):

let colorNamesEN = [ "None", "Gray", "Green", "Purple", "Blue", "Yellow", "Red", "Orange" ]
let colorNamesDE = [ "",     "Grau", "Grün",  "Lila",   "Blau", "Gelb",   "Rot", "Orange" ]

public enum TagColors : Int8 {
    case None = -1, Gray, Green, Purple, Blue, Yellow, Red, Orange, Max
}

//let theURL : NSURL = NSURL.fileURLWithPath("/Users/dirk/Documents/MyLOG.txt")

extension NSURL {
    // e.g.  theURL.setColors(0b01010101)
    func tagColorValue(tagcolor : TagColors) -> UInt16 {
        return 1 << UInt16(tagcolor.rawValue)
    }

    func addTagColor(tagcolor : TagColors) -> Bool {
        let bits : UInt16 = tagColorValue(tagcolor) | self.getTagColors()
        return setTagColors(bits)
    }

    func remTagColor(tagcolor : TagColors) -> Bool {
        let bits : UInt16 = ~tagColorValue(tagcolor) & self.getTagColors()
        return setTagColors(bits)
    }

    func setColors(tagcolor : TagColors) -> Bool {
        let bits : UInt16 = tagColorValue(tagcolor)
        return setTagColors(bits)
    }

    func setTagColors(colorMask : UInt16) -> Bool {
        // get string for all available and requested bits
        let arr = colorBitsToStrings(colorMask & (tagColorValue(TagColors.Max)-1))

        do {
            try self.setResourceValue(arr, forKey: NSURLTagNamesKey)
            return true
        }
        catch {
            print("Could not write to file \(self.absoluteURL)")
            return false
        }
    }

    func getTagColors() -> UInt16 {
        return getAllTagColors(self.absoluteURL)
    }
}


// let initialBits: UInt8 = 0b00001111
func colorBitsToStrings(colorMask : UInt16) -> NSArray {
    // translate bits to (localized!) color names
    let countryCode = NSLocale.currentLocale().objectForKey(NSLocaleLanguageCode)!

    // I don't know how to automate it for all languages possible!!!!
    let colorNames = countryCode as! String == "de" ? colorNamesDE : colorNamesEN

    var tagArray = [String]()
    var bitNumber : Int = -1   // ignore first loop
    for colorName in colorNames {
        if bitNumber >= 0 {
            if colorMask & UInt16(1<<bitNumber) > 0 {
                tagArray.append(colorName)
            }
        }
        bitNumber += 1
    }
    return tagArray
}


func getAllTagColors(file : NSURL) -> UInt16 {
    var colorMask : UInt16 = 0

    // translate (localized!) color names to bits
    let countryCode = NSLocale.currentLocale().objectForKey(NSLocaleLanguageCode)!
    // I don't know how to automate it for all languages possible!!!!
    let colorNames = countryCode as! String == "de" ? colorNamesDE : colorNamesEN
    var bitNumber : Int = -1   // ignore first loop

    var tags : AnyObject?

    do {
        try file.getResourceValue(&tags, forKey: NSURLTagNamesKey)
        if tags != nil {
            let tagArray = tags as! [String]

            for colorName in colorNames {
                if bitNumber >= 0 {
                    // color name listed?
                    if tagArray.filter( { [=11=] == colorName } ).count > 0 {
                        colorMask |= UInt16(1<<bitNumber)
                    }
                }
                bitNumber += 1
            }
        }
    } catch {
        // process the error here
    }

    return colorMask
}

多亏了新的 URLResourceValues() 结构和标签编号,我无需知道颜色名称就可以使用它。

知道这些标签编号中的每一个都代表一种标签颜色:

0 None
1 灰色
2 绿色
3 紫色
4 蓝色
5 黄色
6 红色
7 橙色

为您的文件创建一个 URL:

var url = URL(fileURLWithPath: pathToYourFile)

它必须是一个 var,因为我们要改变它。

创建一个新的URLResourceValues实例(也需要是一个变量):

var rv = URLResourceValues()

像这样设置标签编号:

rv.labelNumber = 2 // green

最后,将标签写入文件:

do {
    try url.setResourceValues(rv)
} catch {
    print(error.localizedDescription)
}

在我们的示例中,我们将数字标签设置为 2,因此现在此文件被标记为绿色。

要设置单一颜色,setResourceValue API 调用确实是您应该使用的。但是,您应该使用的资源密钥是 NSURLLabelNumberKey,或 Swift 中的 URLResourceKey.labelNumberKey 3(不是 NSURLTagNamesKey):

enum LabelNumber: Int {
    case none
    case grey
    case green
    case purple
    case blue
    case yellow
    case red
    case orange
}

do {
    // casting to NSURL here as the equivalent API in the URL value type appears borked:
    // setResourceValue(_, forKey:) is not available there, 
    // and setResourceValues(URLResourceValues) appears broken at least as of Xcode 8.1…
    // fix-it for setResourceValues(URLResourceValues) is saying to use [URLResourceKey: AnyObject], 
    // and the dictionary equivalent also gives an opposite compiler error. Looks like an SDK / compiler bug. 
    try (fileURL as NSURL).setResourceValue(LabelNumber.purple.rawValue, forKey: .labelNumberKey)
}
catch {
    print("Error when setting the label number: \(error)")
}

(这是 [=19= 的 Swift 3 端口。使用 Xcode 8.1、macOS Sierra 10.12.1 测试)

要设置多种颜色,您可以使用 API 您在设置资源值时使用的标签键。此处描述了这两种编码之间的区别:http://arstechnica.com/apple/2013/10/os-x-10-9/9/——基本上标签键在内部设置扩展属性 "com.apple.metadata:_kMDItemUserTags",它将这些标签字符串的数组存储为二进制 plist,而显示的单色选项上面是设置 32 字节长扩展属性值的第 10 个字节 "com.apple.FinderInfo".

该键名中的 "localized" 有点令人困惑,因为实际上用它设置的是用户选择的标签集,在用户设置的标签名称中。这些标签值确实是本地化的,但仅限于在您最初创建帐户时根据本地化设置设置的范围内。为了演示,这些是 Finder 在我的系统上使用的标签值,我将其设置为芬兰语本地化作为测试并重新启动 Finder,重新启动计算机等:

➜  defaults read com.apple.Finder FavoriteTagNames
(
    "",
    Red,
    Orange,
    Yellow,
    Green,
    Blue,
    Purple,
    Gray
)

数据在那个二进制plist值中的编码方式只是最喜欢的标签名称后跟它在数组中的索引(长度固定为8,实际值从1开始,即匹配七个颜色顺序为红、橙、黄、绿、蓝、紫、灰)。例如:

xattr -p com.apple.metadata:_kMDItemUserTags foobar.png | xxd -r -p | plutil -convert xml1 - -o -
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<array>
    <string>Gray
1</string>
    <string>Purple
3</string>
    <string>Green
2</string>
    <string>Red
6</string>
</array>
</plist>

因此,不考虑系统本地化,实际上,使用任何字符串后跟换行符和 1-7 之间的数字设置标签将在 Finder 中显示标签所指示的颜色指数。但是,要知道要应用的正确当前值以从最喜欢的标签集中获取要应用的标签(以便颜色和标签匹配),您需要从 Finder 首选项中读取该键(键 'FavoriteTagNames' 来自域 'com.apple.Finder',它编码了上面显示的那些喜欢的标签名称的数组)。

忽略上述复杂情况,以防您希望标签名称 颜色正确,需要从 Finder 首选项域中读取(您可能会或可能不会这样做,取决于你的应用程序是否是沙盒),如果你想使用多种颜色,这里有一个示例解决方案,它直接使用扩展属性值设置颜色(我使用 SOExtendedAttributes 以避免必须触摸笨重的 xattr C APIs):

enum LabelNumber: Int {
    case none
    case gray
    case green
    case purple
    case blue
    case yellow
    case red
    case orange

    // using an enum here is really for illustrative purposes:
    // to know the correct values to apply you would need to read Finder preferences (see body of my response for more detail).
    var label:String? {
        switch self {
        case .none: return nil
        case .gray: return "Gray\n1"
        case .green: return "Green\n2"
        case .purple: return "Purple\n3"
        case .blue: return "Blue\n4"
        case .yellow: return "Yellow\n5"
        case .red: return "Red\n6"
        case .orange: return "Orange\n7"
        }
    }

    static func propertyListData(labels: [LabelNumber]) throws -> Data {
        let labelStrings = labels.flatMap { [=13=].label }
        let propData = try! PropertyListSerialization.data(fromPropertyList: labelStrings,
                                                           format: PropertyListSerialization.PropertyListFormat.binary,
                                                           options: 0)
        return propData
    }
}

do {
    try (fileURL as NSURL).setExtendedAttributeData(LabelNumber.propertyListData(labels: [.gray, .green]),
                                                     name: "com.apple.metadata:_kMDItemUserTags")
}
catch {
    print("Error when setting the label number: \(error)")
}

历史

首先是我之前的回答,它适用于为文件设置一个颜色标签:.

然后@mz2 posted this excellent answer which successfully sets several color labels to a file and explains the process: .

现在这个小插件,一个简单的 @mz2 的回答。

解决方案

我只是实施了@mz2 的建议:我已经扩展了他的枚举示例,其中包含获取 Finder 首选项的方法,并在将属性设置到文件之前提取正确的本地化标签颜色名称。

enum LabelColors: Int {
    case none
    case gray
    case green
    case purple
    case blue
    case yellow
    case red
    case orange

    func label(using list: [String] = []) -> String? {
        if list.isEmpty || list.count < 7 {
            switch self {
            case .none: return nil
            case .gray: return "Gray\n1"
            case .green: return "Green\n2"
            case .purple: return "Purple\n3"
            case .blue: return "Blue\n4"
            case .yellow: return "Yellow\n5"
            case .red: return "Red\n6"
            case .orange: return "Orange\n7"
            }
        } else {
            switch self {
            case .none: return nil
            case .gray: return list[0]
            case .green: return list[1]
            case .purple: return list[2]
            case .blue: return list[3]
            case .yellow: return list[4]
            case .red: return list[5]
            case .orange: return list[6]
            }
        }
    }

    static func set(colors: [LabelColors],
                    to url: URL,
                    using list: [String] = []) throws
    {
        // 'setExtendedAttributeData' is part of https://github.com/billgarrison/SOExtendedAttributes
        try (url as NSURL).setExtendedAttributeData(propertyListData(labels: colors, using: list),
                                                    name: "com.apple.metadata:_kMDItemUserTags")
    }

    static func propertyListData(labels: [LabelColors],
                                 using list: [String] = []) throws -> Data
    {
        let labelStrings = labels.flatMap { [=10=].label(using: list) }
        return try PropertyListSerialization.data(fromPropertyList: labelStrings,
                                                  format: .binary,
                                                  options: 0)
    }

    static func localizedLabelNames() -> [String] {
        // this doesn't work if the app is Sandboxed:
        // the users would have to point to the file themselves with NSOpenPanel
        let url = URL(fileURLWithPath: "\(NSHomeDirectory())/Library/SyncedPreferences/com.apple.finder.plist")

        let keyPath = "values.FinderTagDict.value.FinderTags"
        if let d = try? Data(contentsOf: url) {
            if let plist = try? PropertyListSerialization.propertyList(from: d,
                                                                       options: [],
                                                                       format: nil),
                let pdict = plist as? NSDictionary,
                let ftags = pdict.value(forKeyPath: keyPath) as? [[AnyHashable: Any]]
            {
                var list = [(Int, String)]()
                // with '.count == 2' we ignore non-system labels
                for item in ftags where item.values.count == 2 {
                    if let name = item["n"] as? String,
                        let number = item["l"] as? Int {
                        list.append((number, name))
                    }
                }
                return list.sorted { [=10=].0 < .0 }.map { "\([=10=].1)\n\([=10=].0)" }
            }
        }
        return []
    }
}

用法:

do {
    // default English label names
    try LabelColors.set(colors: [.yellow, .red],
                        to: fileURL)

    // localized label names
    let list = LabelColors.localizedLabelNames()
    try LabelColors.set(colors: [.green, .blue],
                        to: fileURL,
                        using: list)
} catch {
    print("Error when setting label color(s): \(error)")
}

NSWorkspace 具有 return 所有标签名称和颜色的功能:

https://developer.apple.com/documentation/appkit/nsworkspace/1527553-filelabelcolors

https://developer.apple.com/documentation/appkit/nsworkspace/1533953-filelabels