HSDN Cinema Archiver
====================

1. ОПИСАНИЕ
-----------

Данное программное обеспечение (ПО) представляет собой систему организации библиотеки (каталога) 
фильмов, расположенных в рамках файловой системы (локальной или удаленной).

Основной функций организации библиотеки является – переименование файлов фильмов в соответствии с 
внутренним форматом каталога. Переименованию подлежат только те файлы, которые содержат 
первоначальный минимум информации: название фильма и год выпуска в формате:
  "Название (год)[ суффикс файла].ext". Где "ext" – расширение файла фильма.

Примеры имени файлов фильмов, подлежащих переименованию:
   "Белая валентинка (1999).avi"
   "Ромашка (2006) DVDRip-AVC.mkv"

Информация для переименования берется из публичного поставщика данных (ППД). После обращения к ППД, 
формируется массив результатов в соответствии с текущим запрашиваемым фильмом. Если найдено одно 
совпадение, происходит переименование файла в соответствии с форматом ниже; если найдено более 
одного совпадения, происходит переименование файла, однако в область идентификатора включается 
"временный флаг" ^TMP, указывающий на то, что информация может быть недостоверной. 
Если совпадения не найдены, файл также переименовывается, в качестве идентификатора задается 0, и 
также включается "временный флаг".

Форматом имени файлов является следующий вид записи:
   "Перое название; Второе название (год; страна1, странаN; жанр1, жанрN)[ суффикс файла] ,,идент.1[^врем.флаг] ,,идент.N[^врем.флаг].ext"

На данный момент ПО поддерживает указание в качестве источника данных, сайта «КиноПоиск».

Примеры имени переименованных файлов фильмов:
   "Белая валентинка; Hwaiteu ballenta-in (1999; Корея Южная; мелодрама) ,,kp65825.avi"
   "Ромашка; Deiji (2006; Корея Южная; драма, мелодрама) DVDRip-AVC ,,kp197069.mkv"

Помимо переименования файлов, в функциональные возможности ПО входит возможность загрузки постеров 
(изображений) и текстовых аннотаций к фильмам из ППД, а также создание JSON-базы данных ("_data.json")
для использования в программе "Интерактивный каталог" версии 1.0 и выше.


2. ПАРАМЕТРЫ ЗАПУСКА
--------------------

Режимы работы:
   -indexing=<ППД>              -- индексация каталога и переименование файлов (требуется указание -movies_folder)
   -find_duplicates=<ППД>       -- поиск дубликатов (требуется указание -movies_folder)
   -download_posters=<ППД>      -- скачивание изображений постеров (требуется указание -movies_folder и -data_folder)
   -download_annotation=<ППД>   -- скачивание аннотации (требуется указание -movies_folder и -data_folder)
   -generate_database           -- создание базы данных JSON (требуется указание -movies_folder и -data_folder)

Окружение:
   -data_folder=<путь>          -- директория данных
   -movies_folder=<путь>        -- директория фильмов
   -catalog_name=<путь>         -- имя каталога

Дополнительно:
   -include_subdirs             -- просматривать поддиректории (их названия должны начинаться на знак _)
   -fs_encoding=<кодировка>     -- установка кодировки файловой системы
   -cli_encoding=<кодировка>    -- установка кодировки консоли (CLI)
   -debug                       -- включение режима отладки (изменения файловой системы не приходят!)


3. ДОСТУПНЫЕ ПУБЛИЧНЫЕ ПОСТАВЩИКИ ДАННЫХ (ППД)
----------------------------------------------

   kp -- Сайт "КиноПоиск"


4. ТИПОВЫЕ ОПЕРАЦИИ
-------------------

Индексация (переименование) фильмов (kp - ППД "КиноПоиск"):
   php\php.exe archiver.phar -indexing=kp -movies_folder="X:\_movies"

Нахождение дубликатов фильмов:
   php\php.exe archiver.phar -find_duplicates -movies_folder="X:\_movies"

Скачивание постеров к фильмам (kp - ППД "КиноПоиск")
   php\php.exe archiver.phar -download_posters=kp -movies_folder="X:\_movies" -data_folder="X:\_descr"

Скачивание аннотаций к фильмам (kp - ППД "КиноПоиск")
   php\php.exe archiver.phar -download_annotation=kp -movies_folder="X:\_movies" -data_folder="X:\_descr"

Генерация базы данных в формате JSON для ПО "Интерактивный каталог"
   php\php.exe archiver.phar -generate_database -movies_folder="X:\_movies" -data_folder="X:\_descr" -catalog_name="Мои фильмы"


------------------------------------
(C) 2016, "Информационные Сети", ООО
Все права защищены.

Веб-сайт: http://www.hsdn.org