Как читать и редактировать файлы plist
Последнее обновление:
Уметь читать и редактировать файл plist — значит работать с форматом конфигурации Apple, файлами «ключ–значение», которые тихо управляют macOS и iOS. Каждое приложение несёт Info.plist, каждое запланированное фоновое задание — это plist launchd, каждый профиль provision и каждый профиль устройства .mobileconfig — это plist внутри. Сам формат прост: словари, массивы, строки, числа, логические значения, даты и блоки бинарных данных, вложенные сколь угодно глубоко. Неприятности начинаются потому, что один и тот же формат поставляется в двух обличьях — читаемый человеком XML и компактная бинарная форма, которая в текстовом редакторе выглядит как мусор, — а также потому, что один неверный тип может молча помешать заданию когда-либо запуститься. Любой plist можно вставить в Plist Workbench и прочитать, отредактировать, преобразовать и проверить в браузере — ничего не загружается, — но эта статья учит читать файлы самостоятельно, чтобы дерево никогда не было для вас чёрным ящиком.
Что такое plist — и четыре обличья, которые он носит
Список свойств, или plist, — это способ Apple хранить структурированную конфигурацию: дерево словарей и массивов, листьями которого являются строки, целые числа, вещественные числа, логические значения, даты и блоки бинарных данных. Это та же идея, что объект JSON или файл YAML, но на платформах Apple она старше обеих и встроена в операционную систему — macOS и iOS читают plist постоянно, ни о чём вас не спрашивая. Если вы когда-нибудь задумывались, где приложение хранит свой bundle ID, версию или запрашиваемые разрешения, ответ — plist, и он всё время был на виду.
Тот же формат встречается в четырёх местах, которые кажутся не связанными, пока не знаешь секрет. Внутри каждого пакета приложения Info.plist объявляет identity приложения: его bundle ID, версию, поддерживаемые типы документов и запрашиваемые разрешения. В ~/Library/LaunchAgents и /Library/LaunchDaemons файлы заданий launchd описывают фоновые задачи — что запускать, когда и при каких условиях. Профиль provision .mobileprovision — это plist (обёрнутый в подпись CMS), в котором перечислено, какие устройства и права может использовать приложение. А профиль устройства .mobileconfig — это plist, описывающий Wi-Fi, VPN, сертификаты и ограничения для установки на устройство. Один формат, четыре обличья — научившись читать одно, вы сможете читать все четыре.
Бинарный против XML: магия bplist00 и почему нельзя редактировать бинарный plist вручную
У plist есть две сериализации. XML-форма начинается с <?xml и <plist version="1.0"> и читается в любом текстовом редакторе: ключи в тегах <key>, значения — в <string>, <integer>, <true/>, <array> и <dict>. Бинарная форма — это компактная кодировка, которая начинается с восьми магических байтов bplist00, за которыми следуют таблица объектов, таблица смещений и трейлер, в котором записано, где что находится. Бинарные plist меньше и быстрее загружаются системой, поэтому большинство plist на настоящем Mac — бинарные, и поэтому при открытии в текстовом редакторе виден мусор.
Как понять, какой у вас: посмотрите на первые байты. bplist00 означает бинарный; <?xml или <plist — XML. И вот правило, которое спасает файлы: никогда не редактируйте бинарные байты вручную. Бинарный plist — это сеть смещений: замените одну строку на более длинную, и все смещения после неё станут неверными, трейлер перестанет совпадать с таблицей, и файл будет повреждён, хотя изменённый вами текст выглядит нормально. Безопасный путь всегда один и тот же: преобразовать бинарный в XML, отредактировать XML, преобразовать обратно в бинарный, а затем заново разобрать результат, чтобы доказать, что он всё ещё валиден. На Mac это plutil -convert xml1 и plutil -convert binary1; в браузере тот же путь туда и обратно проделает за вас Plist Workbench.
Читаем задание launchd вручную: Label, ProgramArguments, RunAtLoad, KeepAlive, StartCalendarInterval
Задание launchd — это plist с небольшим словарём, и его можно прочитать меньше чем за минуту, если знаешь ключи. Label — уникальное имя задания, по соглашению обратный домен вроде com.example.backup: launchd использует его для идентификации задания, и два задания с одинаковым label конфликтуют. ProgramArguments — массив строк: программа для запуска и её аргументы, так что ["/usr/local/bin/backup.sh"] запускает этот скрипт без аргументов. RunAtLoad — логическое значение: true означает запустить задание сразу после загрузки. KeepAlive, тоже логическое, означает перезапускать его всякий раз, когда оно завершается. Эти четыре ключа описывают большинство заданий, которые вам встретятся.
Ключ планирования — StartCalendarInterval, словарь календарных полей: Minute, Hour, Day, Weekday, Month, — любое из которых можно опустить, так что {Hour: 3, Minute: 30} означает каждый день в 03:30. Его более простой родственник StartInterval — одно целое число: запускать каждые N секунд. Образец в блоке кода ниже — полное рабочее задание в этой форме: Label, ProgramArguments, RunAtLoad, StartCalendarInterval, — и его стоит прочитать построчно, потому что каждое задание launchd, которое вам встретится, — это его вариация: те же ключи, другие значения и изредка дополнение вроде WorkingDirectory или StandardOutPath, указывающее, куда идёт вывод.
Ключи, которые всё ломают: ошибки типов, неверные контейнеры, числа вне диапазона
Большинство сломанных заданий launchd сломаны не опечатками — они сломаны типами. launchd ожидает, что ProgramArguments будет массивом строк; дайте ему одну строку, и задание не загрузится, а сообщение об ошибке скажет очень мало. KeepAlive, RunAtLoad и Disabled должны быть логическими значениями, а не строками "true" и "false": строка, в которой написано "true", — это не true, и launchd сочтёт это ошибкой типа. StartInterval должен быть положительным целым числом; ноль или отрицательное число бессмысленно и отклоняется. Это ошибки, которые текстовый редактор никогда не находит, потому что XML идеально well-formed — неверен только смысл.
Вторая семья поломок — числа вне своего диапазона. В StartCalendarInterval Minute должен быть 0–59, Hour — 0–23, Weekday — 0–7, Day — 1–31, а Month — 1–12: Hour, равный 25, означает не «завтра в час ночи», а то, что задание никогда не запустится, и launchd может даже не сказать вам почему. Третья семья — пара, которая не должна встречаться вместе: Program и ProgramArguments — два способа сказать одно и то же, и указание обоих неоднозначно; выберите один и предпочтите ProgramArguments — форму, которую документирует Apple. Валидатор, проверяющий типы, диапазоны и эти конфликты, ловит все три семьи до того, как задание попадёт в launchd, — именно это и делают проверки launchd в workbench.
Безопасное редактирование: резервная копия, преобразование, правка, обратное преобразование, проверка
Безопасное редактирование plist — это ритуал из пяти шагов, и порядок важен. Во-первых, сделайте резервную копию исходного файла — скопируйте его куда-нибудь, прежде чем трогать, потому что у задания launchd или профиля устройства нет кнопки отмены. Во-вторых, если файл бинарный, преобразуйте его в XML; никогда не редактируйте бинарные байты напрямую по причинам смещений, описанным выше. В-третьих, внесите правку в XML: измените значение, переименуйте ключ, добавьте элемент массива — и сохраняйте правильные типы: строка там, где должна быть строка, массив там, где должен быть массив. В-четвёртых, преобразуйте обратно в бинарный, если исходный был бинарным, чтобы файл вернулся в той форме, которую ожидает система.
В-пятых, и это шаг, который чаще всего пропускают: проверьте повторным разбором. Запустите plutil -lint на результате или вставьте его в workbench и посмотрите, как он чисто разбирается: если файл разбирается заново и вернувшиеся значения — те, которые вы хотели, правка удалась. Если он не разбирается, у вас всё ещё есть резервная копия из шага один, а файл на диске редактор вообще не трогал: workbench редактирует копию в памяти и записывает файл только когда вы явно его экспортируете. Это последнее свойство — весь смысл редактирования в браузере: оригинал остаётся нетронутым, пока вы не решите, что новая версия хороша.
Что делает Plist Workbench — и чего он не делает
Workbench разбирает обе формы plist — бинарную bplist00 и XML — в дерево, которое можно разворачивать, искать по пути (например, StartCalendarInterval.Hour) и редактировать на месте: изменить скаляр, переименовать ключ, добавить или удалить ключи и элементы массива, изменить тип значения, где это однозначно. Каждый экспорт — XML-plist, бинарный plist, JSON или CSV сплющенной таблицы путей — отражает отредактированную модель, а не исходный файл. Когда plist похож на задание launchd, он выполняет семантические проверки из предыдущих разделов: Label присутствует, ровно один из Program и ProgramArguments, календарные поля в диапазоне, логические значения действительно логические. Это и есть вся работа, и всё происходит в вашем браузере: файл никогда не покидает ваше устройство.
Не менее важно, чего он не делает. Он ничего не устанавливает: он не загрузит ваше задание в launchd, не установит .mobileconfig на устройство и не подготовит приложение; это системные действия, и веб-страница не должна их выполнять. Он не проверяет подписи кода или права provision на соответствие Apple, поэтому отредактированный .mobileprovision может идеально разбираться и всё равно быть отклонённым системой, потому что его подпись больше не совпадает: разбор — это не доверие. И он ничего не запускает из plist: задание launchd, указывающее на скрипт, — это данные, пока launchd его не выполнит, и workbench относится к нему как к данным. Для эквивалента на Android — манифеста внутри APK — используйте APK Analyzer; для родственника launchd в Linux, юнитов systemd, — systemd Unit Auditor.
Попробуйте сами: задание launchd, которое можно прочитать, преобразовать и проверить
# A minimal launchd job, as XML — the form you can read and edit safely
<?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">
<dict>
<key>Label</key>
<string>com.example.backup</string>
<key>ProgramArguments</key>
<array>
<string>/usr/local/bin/backup.sh</string>
</array>
<key>RunAtLoad</key>
<true/>
<key>StartCalendarInterval</key>
<dict>
<key>Hour</key>
<integer>3</integer>
<key>Minute</key>
<integer>30</integer>
</dict>
</dict>
</plist>
# Convert between the two forms on a Mac — never edit the binary bytes:
$ plutil -convert xml1 job.plist # binary -> readable XML
$ plutil -convert binary1 job.plist # XML -> compact binary, for shipping
$ plutil -lint job.plist # re-parse to verify it is still valid