You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

197 lines
25 KiB

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

ТЕХНИЧЕСКОЕ ЗАДАНИЕ на разработку утилиты **ubl-settings-bootloader**
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-bootloader**
1. Название приложения, публичное: **Загрузка системы**
1. Стек технологий:
1. Язык программирования: Bash или C(++)
1. Приложение для разработки графического интерфейса: Glade 3
1. Графические библиотеки: GTK3
1. Операционная система разработки: UBLinux DB
1. Структура:
1. Bash/C(++): Весь функционал сосредоточен в графической части, вызовы и исполнение процедур написаны на языках Bash, C(++)
**/usr/bin/ubl-settings-bootloader (скомпилированный бинарный файл)**
1. Графическая часть, фронт
Файл **glade** скомпилирован в бинарный файл
1. Стили виджетов GTK
Файл **css** скомпилирован в бинарный файл
1. Элементы изображений
**/usr/share/ubl-settings-bootloader/images/{\*.png,\*.svg}**
1. Локализация En/Ru
Для локализации должен быть создан файл-шаблон ***name_programm.pot***, на его основе должны быть созданы сами ***po-файлы*** переводов на необходимые языки, через файл сборки из po-файлов компилируются ***mo-файлы*** и размещаются сценарием установки по указанному пути:
**/usr/share/locale/\${LANG}/LC_MESSAGES/${FILE_MO}**
где ${LANG} - каталог с именем локали, например, "ru" или "ru_RU",
\${FILE_MO} - файл локализации программы, например, "${NAME_APPLICATION}.mo"
1. Файл с перечнем и описанием параметров передаваемых ядру
**/usr/share/ubl-sttings-bootloadr/boot-options.csv**
1. Файл с перечнем и описанием параметров терминала для ввода
**/usr/share/ubl-sttings-bootloadr/input-options.csv**
1. Файл с перечнем и описанием параметров терминала для вывода
**/usr/share/ubl-sttings-bootloadr/output-options.csv**
1. **ТЕХНИЧЕСКОЕ ЗАДАНИЕ:**
1. Ярлык (desktop-файл):
1. Type: Application
1. Exec: ubl-settings-bootloader
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. счётчик от 1 до 60 с лэйблом "секунд". Статический элемент. Выравнивание по левому краю.
1. лэйбл "Загрузка по умолчанию:". Статический элемент. Выравнивание по левому краю.
1. комбобокс с вариантами выбора ОС для загрузки. Динамический элемент. Выравнивание по левому краю. Делит пространство с соседними элементами.
1. чекбокс "Последний выбор станет выбором загрузки по умолчанию". Статический элемент. Выравнивание по левому краю.
1. Блок с заголовком "Параметры, передаваемые ядру". Динамический элемент. От края до края окна по горизонтали.
1. Таблица со скроллбаром. Динамический элемент. От края до края родительского элемента по горизонтали. Заголовок: столбец "Активно" чекбоксы (на активацию опции), столбец "Опция", столбец "Значение". Содержимое:
1. чекбокс, quiet, Загрузка без текстовых сообщений
1. чекбокс, splash, Показывать окно приветствия
1. чекбокс, noplymouth, Отключить Plymouth
1. чекбокс, acpi=off, Отключить ACPI
1. чекбокс, noapic, Отключить APIC
1. чекбокс, nolapic, Отключить локальный APIC
1. чекбокс, single, Режим одного пользователя
1. чекбокс, nomodeset, Отключить выбор и загрузку ядром драйверов видео
1. чекбокс, i915.enable_dc=0, Отключить управление питанием графического процессора
1. чекбокс, ahci.mobile_lpm_policy=1, Максимальная производительность, управление питанием
1. чекбокс, snd-intel-dspcfg.dsp_driver=1, Принудительный выбор драйвера звукового устройства от Intel
1. чекбокс, intel_idle.max_cstate=1, Предотвращает переход процессора в состояние глубокого сна
1. чекбокс, intel_idle.max_cstate=4, Устраняет мерцание дисплея ноутбука на процессорах Ultra Voltage
1. Поле ввода с лэйблом "Параметры командной строки:". Динамический элемент. От края до края родительского элемента по горизонтали.
1. Блок с заголовком "Терминал для ввода". Динамический элемент. От края до края окна по горизонтали.
1. Таблица со скроллбаром. Динамический элемент. От края до края родительского элемента по горизонтали. Заголовок: столбец "Активно" чекбоксы (на активацию опции), столбец "Опция", столбец "Значение". Содержимое:
1. чекбокс, console, PC BIOS & консоль EFI
1. чекбокс serial, Последовательный терминал
1. чекбокс, ofconsole, Консоль Open Firmware
1. чекбокс, at_keyboard, Клавиатура PC AT (Coreboot)
1. чекбокс, usb_keyboard, Клавиатура USB Keyboard (протокол HID Boot)
1. поле ввода с лэйблом "Параметры командной строки:". Динамический элемент. От края до края родительского элемента по горизонтали.
1. Блок с заголовком "Терминал для вывода". Динамический элемент. От края до края окна по горизонтали.
1. Таблица со скроллбаром. Динамический элемент. От края до края родительского элемента по горизонтали. Заголовок: столбец "Активно" чекбоксы (на активацию опции), столбец "Опция", столбец "Значение". Содержимое:
1. чекбокс, console, PC BIOS & консоль EFI
1. чекбокс, serial, Последовательный терминал
1. чекбокс, ofconsole, Консоль Open Firmware
1. чекбокс, gfxterm, Вывод в графическом режиме
1. чекбокс, vga_text, Текстовый вывод VGA (Coreboot)
1. поле ввода с лэйблом "Параметры командной строки:". Динамический элемент. От края до края родительского элемента по горизонтали.
1. **ОСОБЕННОСТИ**
1. При загрузке утилиты по умолчанию загружаются данные из локального конфигурационного файла (выполняются команды блоков "Чтение значений: из локального конфигурационного файла").
1. Функции записи в локальный конфигурационный файл и чтения-записи в глобальный конфигурационный файл должны проходить процедуру повышения привилегий прав пользователя через polkit.
1. Кнопка "Загрузить" -> ("Загрузить глобальную конфигурацию, Загрузить локальную конфигурацию"). При нажатии на кнопку происходит открытие меню с пунктами: "Загрузить глобальную конфигурацию, Загрузить локальную конфигурацию". Загрузка текущей и глобальной конфигурации в системе через скрипт ubconfig (выполняются команды блоков "Чтение значений: из локального конфигурационного файла"), загрузка конфигурации из файла настроек ОС ublinux.ini (выполняются команды блоков "Чтение значений: из глобального конфигурационного файла").
1. Кнопка "Сохранить" -> ("Сохранить в глобальную и локальную конфигурацию). Сохраняет текущие настройки через скрипт ubconfig (выполняются команды блоков "Установить значение: в локальный конфигурационный файл") и в конфигурационный файл настроек ОС ublinux.ini (выполняются команды блоков "Установить значение: в глобальный конфигурационный файл"). При выборе пунктов "Сохранить в глобальную конфигурацию, Сохранить в локальную конфигурацию" происходит отдельное сохранение настроек.
1. Обработчик ошибок. Встроенный небольшой обработчик кодов внутренних ошибок, который должен передавать статус возникшей ошибки в строку уведомления. Например: "Невозможно прочитать значение параметра XXXXXX!"
1. Строка уведомлений. Цвет в зависимости от сигнала:
- песочный, пиктограмма "Птичка", сообщения об удачных загрузках или сохранениях конфигураций системы.
- красный, пиктограмма "Восклицательный знак", сообщения об ошибках при сохранении, загрузке параметров конфигурации, при ошибках в работе программы, полученных от обработчика ошибок.
1. Окно с выводом информации о программе:
1. Заголовок окна по локализованному названию утилиты
1. Копирайты, порядок:
1. Иконка приложения
1. Название утилиты
1. Версия программы
1. Название утилиты, локализованное
1. Ссылка "Домашняя страница проекта" на https://ublinux.ru/
1. Авторские права © ООО "Юбисофт", 2022 - $LASTYEAR
- локализованный (en_EN) вариант: "Copyright © UBSoft LLC, 2022 - $LASTYEAR"
- где $LASTYEAR - текущий год.
1. Поля "Параметры командной строки" заполняются автоматически при выборе необходимых параметров в таблицах соответствующих блоков (активация через чекбоксы), в поле передаётся название параметра и его значение (если значение имеется), разделение через пробел.
1. При удалении параметра из поля "Параметры командной строки" соответствующий параметр теряет свой статус активности (галочка снимается) в таблице соответствующего блока.
1. При редактировании (изменении) параметра в поле "Параметры командной строки" соответствующий параметр теряет свой статус активности (галочка снимается) в таблице соответствующего блока.
1. Значения параметров, передаваемых ядру, берутся из файла /usr/share/ubl-sttings-bootloadr/boot-options.csv
1. Значения параметров, терминала для ввода, берутся из файла /usr/share/ubl-sttings-bootloadr/input-options.csv
1. Значения параметров, терминала для вывода, берутся из файла /usr/share/ubl-sttings-bootloadr/output-options.csv
1. Вывод файлов csv так же должен быть локализован средствами pot-, po-, mo- файлов.
1. **КОМАНДЫ**
1. Меню загрузки
1. Таймер выбора варианта загрузки:
1. Чтение значения:
1. из локального конфигурационного файла: `/usr/bin/ubconfig --default --source system get config XXXXXX`
1. из глобального конфигурационного файла: `/usr/bin/ubconfig --default --source global get config XXXXXX`
1. Установить значение:
1. в локальный конфигурационный файл: `/usr/bin/ubconfig --target system set config XXXXXX=$VALUE`
1. в глобальный конфигурационный файл: `/usr/bin/ubconfig --target global set config XXXXXX=$VALUE`
где $VALUE - параметр, цифровой, от 1 до 60.
1. Загрузка по умолчанию:
1. Должен быть получен список ОС и вариантов загрузки.
1. Последний выбор станет выбором загрузки по умолчанию:
1. Чтение значения:
1. из локального конфигурационного файла: `/usr/bin/ubconfig --default --source system get config XXXXXX`
1. из глобального конфигурационного файла: `/usr/bin/ubconfig --default --source global get config XXXXXX`
1. Установить значение:
1. в локальный конфигурационный файл: `/usr/bin/ubconfig --target system set config XXXXXX=$VALUE`
1. в глобальный конфигурационный файл: `/usr/bin/ubconfig --target global set config XXXXXX=$VALUE`
где $VALUE - параметр, цифровой, 1 или 0. Указывает на включение или отключение данной опции.
1. Параметры, передаваемые ядру
1. через функции фронтенда передавать выбранный параметр в поле "Параметры командной строки" блока "Параметры, передаваемые ядру"
1. Параметры командной строки:
1. Чтение значения:
1. из локального конфигурационного файла: `/usr/bin/ubconfig --default --source system get config CMDLINE`
1. из глобального конфигурационного файла: `/usr/bin/ubconfig --default --source global get config CMDLINE`
1. Установить значение:
1. в локальный конфигурационный файл: `/usr/bin/ubconfig --target system set config CMDLINE=$VALUE`
1. в глобальный конфигурационный файл: `/usr/bin/ubconfig --target global set config CMDLINE=$VALUE`
где $VALUE - перечень параметров, полученных исходя из выбранных опций в блоке "Параметры, передаваемые ядру", разделённых пробелом.
1. Терминал для ввода
1. через функции фронтенда передавать выбранный параметр в поле "Параметры командной строки" блока "Терминал для ввода"
1. Параметры командной строки:
1. Чтение значения:
1. из локального конфигурационного файла: `/usr/bin/ubconfig --default --source system get config XXXXXX`
1. из глобального конфигурационного файла: `/usr/bin/ubconfig --default --source global get config XXXXXX`
1. Установить значение:
1. в локальный конфигурационный файл: `/usr/bin/ubconfig --target system set config XXXXXX=$VALUE`
1. в глобальный конфигурационный файл: `/usr/bin/ubconfig --target global set config XXXXXX=$VALUE`
где $VALUE - перечень параметров, полученных исходя из выбранных опций в блоке "Терминал для ввода", разделённых пробелом.
1. Терминал для вывода
1. через функции фронтенда передавать выбранный параметр в поле "Параметры командной строки" блока "Терминал для вывода"
1. Параметры командной строки:
1. Чтение значения:
1. из локального конфигурационного файла: `/usr/bin/ubconfig --default --source system get config XXXXXX`
1. из глобального конфигурационного файла: `/usr/bin/ubconfig --default --source global get config XXXXXX`
1. Установить значение:
1. в локальный конфигурационный файл: `/usr/bin/ubconfig --target system set config XXXXXX=$VALUE`
1. в глобальный конфигурационный файл: `/usr/bin/ubconfig --target global set config XXXXXX=$VALUE`
где $VALUE - перечень параметров, полученных исходя из выбранных опций в блоке "Терминал для вывода", разделённых пробелом.
1. **ПРИБЛИЗИТЕЛЬНЫЙ МАКЕТ ПРИЛОЖЕНИЯ.**
1. Главное окно
![](https://gitea.ublinux.ru/miramax166/design-ubl-settings-apps/raw/branch/master/ubl-settings-bootloader/pic/01%28ru_RU%29.png)