Polecenie "config"

Polecenie zaprojektowane docelowo do konfigurowania wszystkich obsługiwanych przez sowizora pakietów oprogramowania, w tej chwili realizuje tylko konfigurację pakietu "sowizor".

Składnia

sowizor config <pakiet> [<parametr>] [<wartość>] [--remove] [--show]
sowizor config <pakiet> [<grupa>] [--remove]

Działanie

Polecenie wyświetli bieżącą wartość parametru (lub parametrów) wybranego pakietu i pozwoli na ich zmianę.

Jako <pakiet> należy podać nazwę konfigurowanego pakietu. Obecnie obsługiwane są pakiety sowizor, asio i zed.

Jako [<parametr>] należy podać nazwę parametru, którego wartość ma być wyświetlona/zmieniona.

W przypadku podania wartości (jako [<wartość>]) - zostanie automatycznie ustawiona wartość parametru. W przypadku jej pominięcia - program zapyta w nową wartość (aby pozostawić aktualną wartość parametru wystarczy wcisnąć Enter).

Dodatkowa opcja --show, która jest dostępna w przypadku podania nazwy parametru, pozwala wyświetlić na wyjściu bieżącą wartość parametru, bez próby zmiany jego wartości.

sowizor config
sowizor config sowizor update_site
sowizor config sowizor sowizor.default.licence sowa2/inf/sokrates.lic
sowizor config sowizor arch_password --remove
sowizor config sowizor arch_dvd --show

W powyższym przykładzie nazwa parametru została wyrażona raz w postaci pojedynczego identyfikatora, a raz w postaci identyfikatorów oddzielonych kropkami. Są to - w przypadku parametrów podstawowych danego pakietu - wywołania równoważne (zob. dalej - nazewnictwo parametrów). Tzn. pominięcie prefiksu "sowizor.default." jest dopuszczalne, choć faktyczna nazwa parametru składa się z trzech elementów - grupa parametrów (tu: sowizor), identyfikator grupy (tu: default) i nazwa parametru. Znajdzie to uzasadnienie w przypadku definiowania dla pakietu całych grup parametrów, np. konfiguracja kilku skrzynek nadawczych e-mail, albo kilku baz danych dla serwera Z3950.

sowizor config zed db.bibliografia
sowizor config zed db.bibliografia.sowa_sid krakow_kbp_ks
sowizor config zed db.bibliografia --remove

Powyższe przykłady pozwalają kolejno:

• skonfigurować całą grupę parametrów db dla identyfikatora bibliografia
• ustawić wartość parametru db.bibliografia.sowa_sid na krakow_kbp_ks
• usunąć całą grupę db.bibliografia

Typy parametrów

Każdy parametr jest określonego typu - w momencie ustawiania jego wartości program sprawdza poprawność. W zależności od tego typu dopuszcza też różne formy podawania wartości.

text

Podstawowy i domyślny dla większości parametrów typ. Dopuszcza dowolny tekst jako wartość i nie przeprowadza żadnej kontroli poprawności.

int

Parametr będący liczbą całkowitą. Program kontroluje, czy podana wartość faktycznie jest liczbą całkowitą.

bool

Parametr będący wartością logiczną: prawda lub fałsz. Może być podany w postaci cyfry (1 jako prawda, 0 jako fałsz), lub znaku (T jako prawda, N jako fałsz)

url

Parametr będący adresem URL. Program sprawdza nie tylko poprawność składni tego adresu, ale także jego dostępność. Jeśli dany URL jest niedostępny, nie dopuści do ustawienia podawanej wartości.

store

Parametr składujący dane typu binarnego. Podczas zmiany wartości parametru należy podać ścieżkę do pliku (zob. przykład ustawiania parametru sowizor.default.licence), albo napis base64:dane_binarne_zakodowane_w_base64.

password

Parametr będący hasłem. Wartość takiego parametru nie będzie prezentowana podczas wyświetlania, ponadto podczas zmiany jego wartości w trybie interaktywnym wpisywane z klawiatury znaki nie pojawiają się na ekranie.

list

Lista wartości tekstowych.

Nazewnictwo parametrów

Zasadniczo parametr zbudowany jest wg schematu: grupa.id_grupy.nazwa - przy czym podczas pracy na parametrach z grupy "<pakiet>.default" nie trzeba podawać dwóch pierwszych elementów. Tzn. - nazwa sowizor.default.licence oraz licence wskazują na ten sam parametr.

Dostępne parametry

Opisane zostaną tylko parametry pakietu "sowizor", dokumentacja parametrów innych pakietów powinna być dostępna w dokumentacji tych pakietów.

Pakiet "sowizor"

Poniżej opisane

sowizor.default.update_site

Adres URL do strony z aktualizacjami pakietów. (wartość domyślna: http://update.sokrates.pl/)

sowizor.default.licence

Licencja kliencka na system SOWA

sowizor.default.appsrv_url

Adres URL do serwera aplikacji IPUB - obsługującego integrację z portalem http://w.bibliotece.pl

sowizor.default.log_level

Poziom logowania dla usługi "sowizor". Dopuszczalne wartości to:

• info - wszystkie komunikaty informacyjne, a także o błędach i ostrzeżeniach (poziom domyślny)
• warning - tylko komunikaty błędów i ostrzeżeń
• error - tylko komunikaty błędów
• debug - szczegółowe informacje o pracy usługi - tryb przydatny tylko w przypadku diagnozowania problemów z usługą.

sowizor.default.arch_password

Hasło szyfrowania archiwów.

sowizor.default.arch_dvd

Urządzenie, na które mają być nagrywane archiwa. Powinno to być poprawne i istniejące w systemie urządzenie, np. /dev/dvdrw - albo wartość "auto", która pozwala na automatyczne określenie nazwy urządzenia. Wartość pusta oznacza, że archiwa nie będą nagrywane na płyty DVD.