ТЕХНИЧЕСКОЕ ЗАДАНИЕ на разработку утилиты **ubl-settings-datetime**

1. **ОПИСАНИЕ:**
	
	Графическое средство настройки даты и времени в ОС UBLinux

1. **ЭТАПЫ И СРОКИ СОЗДАНИЯ ПРИЛОЖЕНИЯ:**
	1. Общий срок работ по созданию приложения составляет N дней:
		1. N дня - макет и дизайн приложения и его утверждение
		1. N дней - разработка приложения
		1. N дня - тестирование приложения и исправление ошибок
	1. Перечень этапов разработки приложения:
		1. Разработка макета и дизайна приложения
		1. Утверждение и доработка макета
		1. Создание работающего интерфейса, включая полную разработку действующих ярлыков, кнопок и т.д.
	1. Проектирование алгоритма работы приложения
	1. Написание работающего кода приложения, включая полноценно работающие элементы графического интерфейса, а также перевод (поддержка локализации En, Ru), самостоятельно
	1. Тестирование и исправление ошибок, самостоятельно
	1. Публикация

1. **ТЕХНОЛОГИЧЕСКИЕ ТРЕБОВАНИЯ:**
	1. Приложение разрабатывается под нужды операционной системы UBLinux
	1. Использование фирменного логотипа компании
	1. Название приложения, техническое:  **ubl-settings-datetime** (далее **\${NAME_APPLICATION}**)
	1. Название приложения, публичное: **Дата и время**
	1. Описание приложения: **Настройка даты и времени системы**
	1. Стек технологий:
		1. Язык программирования:  Bash или C(++)
		1. Приложение для разработки графического интерфейса: Glade 3
		1. Графические библиотеки: GTK3
		1. Операционная система разработки: UBLinux DB
	1. Структура:
		1. В исходных кодах использовать префикс корня  **CMAKE_INSTALL_PREFIX** для сборки приложений. Например, `CMAKE_INSTALL_PREFIX/share`.
		1. Bash/C(++): Весь функционал сосредоточен в графической части, вызовы и исполнение процедур написаны на языках Bash, C(++)
**/usr/bin/\${NAME_APPLICATION} (скомпилированный бинарный файл)**
		1. Графическая часть, фронт
**/usr/share/\${NAME_APPLICATION}/ui/\${NAME_APPLICATION}.glade**
		1. Стили виджетов GTK
**/usr/share/\${NAME_APPLICATION}/css/\${NAME_APPLICATION}.css**
		1. Элементы изображений
			1. Иконки:
**/usr/share/icons/hicolor/scalable/apps/\${NAME_APPLICATION}{\*.png,\*.svg}**
Файлы изображений png иконок должны иметь имена вида:
				- ru.ublinux.\${NAME_APPLICATION}.svg
				- ru.ublinux.\${NAME_APPLICATION}.\${NAME_ICONS}.svg
Где \${NAME_ICONS} - имя графического элемента, например: checked, warning, alert и т.д.
			Файлы изображений png иконок должны генерироваться из svg файла в размеры 16, 32, 48, 64 пикселей сценарием make-файла.
			1. Изображения:
**/usr/share/\${NAME_APPLICATION}/ui/{\*.png,\*.svg}**
		1. Локализация En/Ru
			1. Для локализации должен быть создан файл-шаблон ***\${NAME_APPLICATION}.pot***, на его основе должны быть созданы сами ***po-файлы*** переводов на необходимые языки, через файл сборки из po-файлов компилируются ***mo-файлы*** и размещаются сценарием установки по указанному пути:
**/usr/share/locale/\${LANG}/LC_MESSAGES/\${FILE_MO}**
где \${LANG} - каталог с именем локали, например, "ru" или "ru_RU",
\${FILE_MO} - файл локализации программы, например, "\${NAME_APPLICATION}.mo"
			1. В файле локализации .pot и .po должна присутствовать строчка информационная, показывающая позицию локализации в коде
				
				Пример:
				```bash
				#: source/${NAME_APPLICATION}.c:41
				msgid "Example string for localization"
				msgstr "Пример строки для локализации"
				```
			1. Вывод **всех** текстовых элементов осуществляется через средства локализации.
		2. Версия ПО
			1. Файл, в котором хранится версия - VERSION.md, находится в корне каталога проекта.
			1. При компиляции (через сценарий make-файла) данные из файла VERSION.md передаются в значение переменной (-ых) version_application в файлах-исходниках ПО.

1. **ТЕХНИЧЕСКОЕ ЗАДАНИЕ:**
	1. Ярлык (desktop-файл):
		1. Type: Application
		1. Exec: ubl-settings-datetime
		1. Categories: X-UBL-SettingsManager;X-UBL-SystemSettings
	1. Главное окно:
		1. Требования к внешнему виду:
			1. Адаптивный (резиновый) дизайн.
			1. Наличие элементов интерфейса:
				1. Статических - не меняют свою ширину при изменении размеров окна или родительского элемента.
				1. Динамических - меняют свою ширину при изменении размеров окна или родительского элемента. Обычно занимают пространство от края до края окна или родительского элемента, либо пространство от рядом расположенного элемента до до края окна или родительского элемента.
			1. Минимальный размер окна до прекращения масштабирования 800 на 600 пикселей.
			1. Шапка в стиле приложений GTK3 с содержимым:
				1. Иконка приложения. Статический элемент. Выравнивание по левому краю.
				1. Кнопка с выпадающим списком "Загрузить" -> ("Загрузить глобальную конфигурацию, Загрузить локальную конфигурацию"). Статический элемент. Выравнивание по левому краю.
				1. Заголовок окна, название приложения. Выравнивание по центру между элементами.
				1. Кнопка с выпадающим списком "Сохранить" -> ("Сохранить в глобальную и локальную конфигурацию, Сохранить в глобальную конфигурацию, Сохранить в локальную конфигурацию"). Статический элемент. Выравнивание по правому краю.
				1. Кнопка с иконкой с выпадающим списком -> "Справка, О приложении". Статический элемент. Выравнивание по правому краю.
				1. Стандартные элементы окна, кнопки "Свернуть, Минимизировать/На весь экран, Закрыть"
			1. В верхней части крупный логотип утилиты, справа от него имя (первая строка) и краткое описание утилиты (вторая строка). Фон заполнен изображением. Статические элементы. Выравнивание по левому краю.
			1. Строка уведомления, представляющая собой полосу с инфографикой строки уведомлений. Динамический элемент. От края до края окна по горизонтали.
			1. Рабочая область.
		1. Требования к "Рабочей области". Динамический элемент. От края до края по горизонтали и вертикали окна. Выводятся группы настроек запуска:
			1. Блок с заголовком "Текущие дата и время". Динамический элемент. От края до края окна по горизонтали.
				1. лейбл "Время". Статический элемент. Выравнивание по левому краю.
				1. счётчик от 00 до 23 (часы). Статический элемент. Выравнивание по левому краю.
				1. лейбл ":" (разделитель). Статический элемент. Выравнивание по левому краю.
				1. счётчик от 00 до 59 (минуты). Статический элемент. Выравнивание по левому краю.
				1. лейбл "Дата". Статический элемент. Выравнивание по левому краю.
				1. поле ввода. Ввод даты в формате ДД.ММ.ГГГГ. Динамический элемент. Выравнивание по левому краю. Делит пространство с соседними элементами.
				1. кнопка с иконкой календаря. Вызов объекта датапикер (визуальное представление выбора даты). Статический элемент. Выравнивание по левому краю.
				1. кнопка "Синхронизировать". Синхронизация выставленных даты и времени с часами и датой системы. Неактивно, если выбраны значения "По умолчанию, DHCP, Вручную" чекбокса в блоке "Синхронизация через NTP". Динамический элемент. Выравнивание по левому краю. Делит пространство в равных долях с соседними элементами.
				1. кнопка "Синхронизировать аппаратное время". Синхронизация даты и времени с временем BIOS рабочей станции. Динамический элемент. Выравнивание по левому краю. Делит пространство в равных долях с соседними элементами.
			1. Блок с заголовком "Синхронизация через NTP". Динамический элемент. От края до края окна по горизонтали.
				1. комбобокс с вариантами выбора сервера: "Остановлено, По умолчанию, DHCP, Вручную". При выборе "По умолчанию", второе поле для ввода вручную становится заблокированным для манипуляций - текст введённого поля серый. При выборе "По умолчанию" в конфигурационный файл передаются значения: "NTPSERVERS=default". Статический элемент. Выравнивание по левому краю.
				1. поле ввода для ручного указания серверов. Неактивно, если выбраны значения "Отключено, Остановлено, По умолчанию, DHCP" комбобокса в блоке "Синхронизация через NTP". Динамический элемент. Выравнивание по левому краю. Делит пространство с соседними элементами.
			1. Блок с заголовком "Часовой пояс". Динамический элемент. От края до края окна по горизонтали.
				1. лейбл "Синхронизация аппаратного времени:". Статический элемент. Выравнивание по левому краю.
				1. комбобокс с вариантами "Локальное время, Время по UTC". Динамический элемент. Выравнивание по левому краю. Делит пространство с соседними элементами.
				1. лейбл "Регион:". Статический элемент. Выравнивание по левому краю.
				1. комбобокс. Локализованный перечень регионов. Динамический элемент. Выравнивание по левому краю. Делит пространство с соседними элементами.
				1. лейбл "Зона:". Статический элемент. Выравнивание по левому краю.
				1. комбобокс. Перечень городов с поправкой на часовой пояс. Например, "(UTC +06) Омск". Перечень регионов, локализация стандартными средствами. Динамический элемент. Выравнивание по левому краю. Делит пространство с соседними элементами.

1. **ОСОБЕННОСТИ**
	1. При загрузке утилиты по умолчанию загружаются данные из локального конфигурационного файла (выполняются команды блоков "Чтение значений: из локального конфигурационного файла").
	1. Функции записи в локальный конфигурационный файл и чтения-записи в глобальный конфигурационный файл должны проходить процедуру повышения привилегий прав пользователя через polkit.
	1. Сохранение должно происходить *только* при наличии изменённых данных в элементах форм приложения, в противном случае выводить в информационной строке сообщение: "Нечего сохранять!".
	1. Кнопка "Загрузить" -> ("Загрузить глобальную конфигурацию, Загрузить локальную конфигурацию"). При нажатии на кнопку происходит открытие меню с пунктами: "Загрузить глобальную конфигурацию, Загрузить локальную конфигурацию". Загрузка текущей и глобальной конфигурации в системе через скрипт ubconfig (выполняются команды блоков "Чтение значений: из локального конфигурационного файла"), загрузка конфигурации из файла настроек ОС ublinux.ini (выполняются команды блоков "Чтение значений: из глобального конфигурационного файла").
	1. Кнопка "Сохранить" -> ("Сохранить в глобальную и локальную конфигурацию). Сохраняет текущие настройки через скрипт ubconfig (выполняются команды блоков "Установить значение: в локальный конфигурационный файл") и в конфигурационный файл настроек ОС ublinux.ini (выполняются команды блоков "Установить значение: в глобальный конфигурационный файл"). При выборе пунктов "Сохранить в глобальную конфигурацию, Сохранить в локальную конфигурацию" происходит отдельное сохранение настроек.
	1. Кнопка с иконкой с выпадающим списком -> "Справка, О приложении"
		1. Справка - запуск окна с встроенным браузером (WebKitWebView) с переходом на ссылку:
			1. локализованный (ru_RU) вариант:
https://wiki.ublinux.ru/ru/Программное_обеспечение/Программы_и_утилиты/Все/\${NAME_APPLICATION} (далее \${URLWIKI})
			1. локализованный (en_EN) вариант:
https://wiki.ublinux.com/ru/Программное_обеспечение/Программы_и_утилиты/Все/\${NAME_APPLICATION} (далее \${URLWIKI})
		Если WebKitWebView не доступен, то запуск через `xdg-open ${URLWIKI}`.
		1. О приложении. Открывается диалоговое окно с выводом информации о программе:
			1. Заголовок окна по локализованному названию утилиты
			1. Копирайты, порядок:
				1. Иконка приложения
				1. Название утилиты
				1. Версия программы (переменная version_application)
				1. Название утилиты, локализованное
				1. Ссылка "Домашняя страница проекта" на https://ublinux.ru/ 
				1. Авторские права © ООО "Юбисофт", 2022 - \$LASTYEAR
					- локализованный (en_EN) вариант: "Copyright © UBSoft LLC, 2022 - \$LASTYEAR"
					- где \$LASTYEAR - текущий год.
	1. Обработчик ошибок. Встроенный небольшой обработчик кодов внутренних ошибок, который должен передавать статус возникшей ошибки в строку уведомления. Например: "Невозможно прочитать значение параметра XXXXXX!"
	1. Строка уведомлений. Цвет в зависимости от сигнала:
		- песочный, пиктограмма "Птичка", сообщения об удачных загрузках или сохранениях конфигураций системы. 
		- красный, пиктограмма "Восклицательный знак", сообщения об ошибках при наличии незаполненных полей (мешающих работе логики программы), при сохранении, загрузке параметров конфигурации, при ошибках в работе программы, полученных от обработчика ошибок.
	1. Блокировать дальнейшую работу с программой:
		1. Если неправильно вручную введены или отредактированы данные в поле "Дата:" то при нажатии на кнопку "Синхронизировать"  - изменить цвет информационной строки на красный и вывести сообщение "Неверный формат даты!".
			1. При исправлении ошибки и повторного нажатия на  кнопку "Синхронизировать" или при корректной работе - изменить цвет информационной строки на песочный и вывести сообщение об успешной синхронизации.
		1. Если неправильно отработал скрипт при нажатии на кнопку "Синхронизировать аппаратное время"  - изменить цвет информационной строки на красный и вывести сообщение "Ошибка синхронизации аппаратных часов!".
			1. При исправлении ошибки и повторного нажатия на  кнопку "Синхронизировать аппаратное время" или при корректной работе скрипта - изменить цвет информационной строки на песочный и вывести сообщение "Аппаратные часы успешно синхронизированы".
		1. Если в комбобоксе блока "Синхронизировать через NTP" выбрано значение "Вручную" - изменить цвет информационной строки на красный и вывести сообщение "Введите NTP-сервер(-ы) для синхронизации!", кнопку "Сохранить" сделать неактивной. 
			1. При исправлении ошибки и потери фокуса поля - изменить цвет информационной строки на песочный и вывести сообщение "NTP-сервер(-ы) корректны", кнопку "Сохранить" сделать активной.

1. **КОМАНДЫ**
	1. Справка, О приложении > Домашняя страница проекта:
`xdg-open \${URLWIKI} &`
	1. Текущие дата и время
		1. Чтение значения:
			1. через средства функции на языке С(++)
		1. Установить значение:
			1. счётчики часы и минуты: `date +%T -s "h:m:sec"` (кнопка "Синхронизировать")
			1. дата: `date +%Y%m%d -s "2000:06:14"` (кнопка "Синхронизировать")
		1. Синхронизировать аппаратное время:
		1. Установить значение: `hwclock --systohc` (кнопка "Синхронизировать аппаратное время")
	1. Синхронизация через NTP
		1. Чтение значения: 
			1. из локального конфигурационного файла: `/usr/bin/ubconfig --default --source system get network NTPSERVERS`
			1. из глобального конфигурационного файла: `/usr/bin/ubconfig --default --source global get network NTPSERVERS`
		1. Установить значение:
			1. "Остановлено" 
			в локальный конфигурационный файл:  `/usr/bin/ubconfig --target system set network NTPSERVERS=stop`
			в глобальный конфигурационный файл: `/usr/bin/ubconfig --target global set network NTPSERVERS=stop`
			1. "По умолчанию"
			в локальный конфигурационный файл:  `/usr/bin/ubconfig --target system set network NTPSERVERS=default`
			в глобальный конфигурационный файл: `/usr/bin/ubconfig --target global set network NTPSERVERS=default`
			1. "DHCP"
			в локальный конфигурационный файл:  `/usr/bin/ubconfig --target system set network NTPSERVERS=dhcp`
			в глобальный конфигурационный файл: `/usr/bin/ubconfig --target global set network NTPSERVERS=dhcp`
			1. "Вручную"
			в локальный конфигурационный файл:  `/usr/bin/ubconfig --target system set network NTPSERVERS=$VALUE`
			в глобальный конфигурационный файл: `/usr/bin/ubconfig --target global set network NTPSERVERS=$VALUE`
			где $VALUE - перечень серверов, полученных из поля в блоке "Синхронизация через NTP", разделённых "," или ";".
		1. Если выбрано значение "По умолчанию", то неактивное поле ввода заполняется командой:
			- `ubconfig --source default get [] NTPSERVERS_DEFAULT`
		1. Проверка запущенных процессов синхронизации (systemd-timesyncd, ntpd, chronyd) и остановка этих сервисов сервисов, осуществляется выполнением команды `/usr/bin/ubconfig remove network NTPSERVERS` при выборе опции "Остановлено" из 	выпадающего списка блока "Синхронизация через NTP"
	1. Часовой пояс
		1. Синхронизация аппаратного времени:
			1. Чтение значений:
				- из локального конфигурационного файла: `/usr/bin/ubconfig --default --source system get clock HWCLOCK_SYNC`
				- из глобального конфигурационного файла: `/usr/bin/ubconfig --default --source global get clock HWCLOCK_SYNC`
			1. Установить значение:
				1. "Локальное время"
				в локальный конфигурационный файл: `/usr/bin/ubconfig --target system set clock HWCLOCK_SYNC=localtime` 
				в глобальный конфигурационный файл: `/usr/bin/ubconfig --target global set clock HWCLOCK_SYNC=localtime`
				1. "Время по UTC"
				в локальный конфигурационный файл: `/usr/bin/ubconfig --target system set clock HWCLOCK_SYNC=utc` 
				в глобальный конфигурационный файл: `/usr/bin/ubconfig --target global set clock HWCLOCK_SYNC=utc`
		1. Комбобокс "Регион", "Зона":
			1. Чтение значений:
				- из локального конфигурационного файла: `/usr/bin/ubconfig --default --source system get clock ZONE`
				- из глобального конфигурационного файла: `/usr/bin/ubconfig --default --source global get clock ZONE`
			1. Установить значение:
				- в локальный конфигурационный файл: `/usr/bin/ubconfig --target system set clock ZONE=$VALUE`
				- в глобальный конфигурационный файл: `/usr/bin/ubconfig --target global set clock ZONE=$VALUE`
				где $VALUE - сложение срок-значений из комбобокса "Регион" и "Зона" через символ "/", например "Asia/Omsk".

1. **ПОМОЩЬ И ПАРАМЕТРЫ ЗАПУСКА**
	1. Помощь
		- Пример вывода:
			> ${NAME_APPLICATION} version: \$VERSION
			> Application Description for UBLinux
			> 
			> Использование:  ${NAME_APPLICATION} [OPTIONS...]
			> Параметры приложения:
			> \$OPTIONS

			Где \$OPTIONS - параметры запуска, \$VERSION - версия программы (переменная version_application).

	1. Параметры запуска:
		1. *-h, --help* - Показать параметры справки
		1. *-V, --version* - Показать текущую версию
		1. *--lock-help* - Блокировка вызова справки
		1. *--lock-save* - Блокировка сохранения локальной и глобальной конфигурации
		1. *--lock-save-local* - Блокировка сохранения локальной конфигурации
		1. *--lock-save-global* - Блокировка сохранения глобальной конфигурации
		1. *--lock-load-global* - Блокировка загрузки глобальной конфигурации
		1. *--lock-datetime* - Блокировка изменения даты и времени
		1. *--lock-timezone* - Блокировка изменения часового пояса
		1. *--lock-ntp-mode* - Блокировка выбора режима NTP
		1. *--lock-ntp-edit* - Блокировка перечня NTP серверов
		1. *--lock-sync-hwclock* - Блокировка выбора режима синхронизации аппаратного времени
	1. Действия при указанных параметрах:
		1. *--lock-help* - делать неактивным пункт "Справка"  в выпадающем списке кнопки с иконкой.
		1. *--lock-save* - делать неактивной кнопку "Сохранить".
		1. *--lock-save-local* - делать неактивным пункт "Сохранить локальную конфигурацию"  в выпадающем списке кнопки "Сохранить".
		1. *--lock-save-global* - делать неактивным пункт "Сохранить глобальную и локальную конфигурацию" и "Сохранить глобальную конфигурацию"  в выпадающем списке кнопки "Сохранить".
		1. *--lock-load-global* - делать неактивным пункт "Сохранить глобальную и локальную конфигурацию" и "Загрузить глобальную конфигурацию"  в выпадающем списке кнопки "Загрузить".
		1. *--lock-datetime* - делать неактивными лейбл "Время:", счётчик (часы), лейбл ":", счётчик (минуты), лейбл "Дата:", поле ввода, кнопка с иконкой календаря.
		1. *--lock-timezone* - делать неактивными лейбл "Регион:", комбобокс с выбором регионов, лейбл "Зона:", комбобокс с выбором зон.
		1. *--lock-ntp-mode* - делать неактивным выпадающий список вариантов синхронизации NTP.
		1. *--lock-ntp-edit* - делать неактивным поле ввода списка серверов NTP.
		1. *--lock-sync-hwclock* -  делать неактивным лейбл "Синхронизация аппаратного времени" и комбобокс с вариантами выбора режима синхронизации аппаратного времени.

1. **ПРИБЛИЗИТЕЛЬНЫЙ МАКЕТ ПРИЛОЖЕНИЯ.**
	1. Главное окно
        
        ![](https://gitea.ublinux.ru/miramax166/design-ubl-settings-apps/raw/branch/master/ubl-settings-datetime/pic/01%28ru_RU%29.png)
 
