API

Main Class

Alignak App

Alignak App manages the creation of all objects and QObjects for the whole application:

• Creation of AppProgressBar until the Data Manager is ready
• Creation of AppQMainWindow
• Creation of standard python objects (settings, css, localization)

class alignak_app.alignakapp.AlignakApp

Bases: PyQt5.QtCore.QObject

Class who build Alignak-app QObjects, initialize configurations, systray icon and Thread Manager.

static check_threads()

Launch periodically threads

static show_login_window()

Show LoginQDialog window for user to login to backend

start(username=None, password=None)

Start Alignak-app

class alignak_app.alignakapp.AppProgressBar

Bases: PyQt5.QtWidgets.QProgressBar

AppProgressBar in busy mode with text displayed at the center.

set_text(text)

Set text of QProgressBar

Parameters:text (str) – text of progress bar

text()

Overload: text(self) -> str

Returns:text of progress bar Return type:str

class alignak_app.alignakapp.AppProgressQWidget(parent=None)

Bases: PyQt5.QtWidgets.QWidget

Class who create a small widget for App start progression

initialize()

Initialize the QWidget

Backend

The Backend package contains classes to manage alignak data

Backend

Backend manage connection and access to Alignak backend. It also fill DataManager.

class alignak_app.backend.backend.BackendClient

Bases: object

Class who collect informations with Backend-Client and returns data for Alignak-App.

acknowledge(item, sticky, notify, comment)

Prepare data for acknowledge and POST on backend API or WS if available

Parameters:

• item (alignak_app.items.host.Host | alignak_app.items.service.Service) – item to acknowledge: host | service
• sticky (bool) – define if ack is sticky or not
• notify (bool) – define if ack should notify user or not
• comment (str) – comment of ack

Returns:

request response

Return type:

dict

downtime(item, fixed, duration, start_stamp, end_stamp, comment)

Prepare data for downtime and POST on backend API or WS if available

Parameters:

• item (alignak_app.items.host.Host | alignak_app.items.service.Service) – item to downtime: host | service
• fixed (bool) – define if donwtime is fixed or not
• duration (int) – duration timestamp of downtime
• start_stamp (int) – start timestamp of downtime
• end_stamp (int) – end timestamp of downtime
• comment (str) – comment of downtime

Returns:

request response

Return type:

dict

get(endpoint, params=None, projection=None, all_items=False)

GET on alignak Backend REST API

Parameters:

• endpoint (str) – endpoint (API URL)
• params (dict|None) – dict of parameters for the app_backend API
• projection (list|None) – list of field to get, if None, get all
• all_items (bool) – make GET on all items

Returns:

request response

Return type:

dict

get_backend_status_icon()

Return backend status icon name

Returns:status icon name Return type:str

get_ws_status_icon()

Return Web Service status icon name

Returns:status icon name Return type:str

login(username=None, password=None, proxies=None, check=False)

Connect to alignak backend

Parameters:

• username (str) – name or token of user
• password (str) – password of user. If token given, this parameter is useless
• proxies (dict) – dictionnary for proxy
• check (bool) – define if login is a check or a first login

Returns:

True if connected or False if not

Return type:

bool

patch(endpoint, data, headers)

PATCH on alignak Backend REST API

Parameters:

• endpoint (str) – endpoint (API URL)
• data (dict) – properties of item to update
• headers (dict) – headers (example: Content-Type). ‘If-Match’ required

Returns:

dictionary containing patch response from the backend

Return type:

dict

post(endpoint, data, headers=None)

POST on alignak Backend REST API

Parameters:

• endpoint (str) – endpoint (API URL)
• data (dict) – properties of item to create | add
• headers (dict|None) – headers (example: Content-Type)

Returns:

response (creation information)

Return type:

dict

query_alignakdaemons()

Launch request on “alignakdaemon” endpoint

query_history(hostname=None, host_id=None)

Launch request on “history” endpoint but only for hosts in “data_manager”

Parameters:

• hostname (str) – name of host we want history
• host_id (str) – id of host for history

query_hosts()

Launch request on “host” endpoint, add hosts in problems if needed

query_livesynthesis()

Launch request on “livesynthesis” endpoint

query_notifications()

Launch request on “history” endpoint. Only for ‘type’: ‘monitoring.notification’ and for current App user

query_realms()

Launch a request on realm endpoint

query_services(host_id=None)

Launch request for “service” endpoint. If host_id is given, only services related to host are added / updated

Parameters:host_id (str) – “_id” of host

query_services_problems(state)

Launch requests on “service” endpoint to get items with “ls_state = state”

Wanted states are: WARNING, CRITICAL and UNKNOWN

Parameters:state (str) – state of service

query_timeperiods()

Launch a request on timeperiod endpoint

query_user()

Launch request on “user” endpoint. Only for current App user.

Data Manager

DataManager manage alignak data provided by Client.

• database fied contains all data collected by App
• db_is_ready fied says to App if database has been filled or not (needed on start)
• old_notifications fied store old notifications from backend to avoid sending them again

class alignak_app.backend.datamanager.DataManager

Bases: object

Class who store alignak data

get_all_hostnames()

Collect and return all names of all hosts

Returns:all names of all hosts Return type:list

get_events()

Get the last events

Returns:events formated for App to send Return type:list

get_host_services(host_id)

Return services corresponding to host ID

Parameters:host_id (str) – ‘_id’ of host Returns:services corresponding to host ID Return type:list

get_host_with_services(host_field)

Returns the desired host and all its services

Parameters:host_field (str) – field of wanted host: host_id | name Returns:dict with host data and its associated services Return type:dict

get_item(item_type, key, value=None)

Return the wanted item for item type who contain the value

Parameters:

• item_type (str) – type of wanted item
• key (str) – key contained in item
• value (str) – value of the key if needed

Returns:

wanted item

Return type:

alignak_app.items.item.*

get_items_and_problems()

Return total of items and problems

Returns:dict of problem and total number for each item Return type:dict

get_period_name(period)

Return the period name or alias

Parameters:period (str) – wanted period _id Returns:the wanted realm alias or name if available Return type:str

get_problems()

Update and return items who are in problem: hosts and services

Returns:dict of items in problem, and number for each type of item Return type:dict

get_realm_name(realm)

Return the realm name or alias

Parameters:realm (str) – wanted realm _id Returns:the wanted realm alias or name if available Return type:str

get_synthesis_count()

Get on “synthesis” endpoint and return the states of hosts and services

Returns:states of hosts and services. Return type:dict

static is_problem(item_type, item_data)

Return True if item data is a problem, else return false. Only if item is monitored (checks are enabled).

Parameters:

• item_type (str) – type of item: “host” or “service”
• item_data (dict) – item of backend

Returns:

if item is a problem or not

Return type:

bool

is_ready()

Check if DataManager is filled and ready

Returns:if ready or current status Return type:str

remove_item(item_type, key, value=None)

Remove the wanted item in “database[item_type]” who contain the “value” or “key”

Parameters:

• item_type (str) – type of wanted item
• key (str) – key contained in item
• value (str) – value of the key if needed

update_database(item_type, items_list)

Update an item type in database

Parameters:

• item_type (str) – type of item to update
• items_list (list | dict) – list of items for the wanted type

update_item_data(item_type, item_id, data)

Update a single item in database

Parameters:

• item_type – type of item (host, service, …)
• item_id (str) – ‘_id’ of item to update
• data (dict) – the data to be updated

update_problems()

Update hosts and services in “problems” database

WS Client

WS Client manage connection and access to Alignak backend by the Web Service module. It will also fill DataManager in future versions.

class alignak_app.backend.ws_client.WSClient

Bases: object

Class who manage Web Service requests

get(endpoint, params)

GET on alignak Backend Web Service

Parameters:

• endpoint (str) – WS endpoint
• params (dict|None) – dict of parameters for the WS

Returns:

request result

Return type:

dict

login(token)

Login to Web Service. Used only to ensure that the user token is identical

Parameters:token (str) – user’s token of App

post(endpoint, params=None)

Post on alignak Backend Web Service

Parameters:

• endpoint (str) – WS endpoint
• params (dict) – dict of parameters for the WS

Returns:

list of properties when query item | list of items when get many items

Return type:

list

Items

The Items package contains classes who create items who are stored in DataManager.

Item

Item is parent class for all items objects:

• Daemon,
• Event,
• History,
• Host,
• LiveSynthesis,
• Period,
• Realm,
• Service,
• User,

class alignak_app.items.item.Item

Bases: object

Class who create an item

create(_id, data, name=None)

Create wanted item

Parameters:

• _id (str) – id of the item. Often equal to id in alignak backend
• data (dict | list) – data of the item
• name (str) – name of the item if available

static get_check_text(check_type)

Return text for check type :param check_type: type of check (active_checks_enabled or passive_checks_enabled) :type check_type: str :return: the corresponding text :rtype: str

get_tooltip()

Return the tooltip message depending state and actions

Returns:toottip message Return type:str

update_data(key, new_value)

Update data of the wanted key

Parameters:

• key (str) – key to update
• new_value – new value of the key

alignak_app.items.item.get_icon_name(item_type, state, acknowledge, downtime, monitored)

Return icon for a host or a service item

Parameters:

• item_type (str) – type of item: host | service
• state (str) – state of item
• acknowledge (bool) – if item is acknowledged or not
• downtime (bool) – if item is downtimed
• monitored (int) – define if host is monitored or not (0 is not monitored, 1 or 2 is monitored)

Returns:

icon name for icon

Return type:

str

alignak_app.items.item.get_icon_name_from_state(item_type, state)

Return icon name from state for host or service

Parameters:

• item_type (str) – type of item: host or service
• state (str) – state of item

Returns:

alignak_app.items.item.get_overall_state_icon(services, host_overall)

Return corresponding icon to max of “_overall_state_id”

Parameters:

• services (list) – list of Service() items
• host_overall (int) – “_overall_state_id” of host

Returns:

icon corresponding to state

Return type:

str

Daemon

Daemon manage creation of daemon item for backend alignakdaemon endpoint

class alignak_app.items.daemon.Daemon

Bases: alignak_app.items.item.Item

Class who create a daemon item

create(_id, data, name=None)

Create wanted item

Parameters:

• _id (str) – id of the item. Often equal to id in alignak backend
• data (dict | list) – data of the item
• name (str) – name of the item if available

static get_check_text(check_type)

Return text for check type :param check_type: type of check (active_checks_enabled or passive_checks_enabled) :type check_type: str :return: the corresponding text :rtype: str

static get_daemons_names()

Returns all the names of daemons

Returns:all the names of daemons Return type:list

static get_daemons_status_icon()

Return daemons status icon name

Returns:daemons status icon name Return type:str

static get_request_model()

Return the request model for alignakdaemon requests

Returns:request model for alignakdaemon endpoint Return type:dict

static get_states(status)

Return states of daemons or backend

Parameters:status (str) – status of item Returns:the status string Return type:str

get_tooltip()

Return the tooltip message depending state and actions

Returns:toottip message Return type:str

update_data(key, new_value)

Update data of the wanted key

Parameters:

• key (str) – key to update
• new_value – new value of the key

Event

Event manage creation of event item (Notifications collected from history endpoint)

class alignak_app.items.event.Event

Bases: alignak_app.items.item.Item

Class who create an event item

create(_id, data, name=None)

Create wanted item

Parameters:

• _id (str) – id of the item. Often equal to id in alignak backend
• data (dict | list) – data of the item
• name (str) – name of the item if available

static get_check_text(check_type)

Return text for check type :param check_type: type of check (active_checks_enabled or passive_checks_enabled) :type check_type: str :return: the corresponding text :rtype: str

static get_request_model()

Return the request model for notification requests

Returns:request model for history endpoint (only for notifications) Return type:dict

get_tooltip()

Return the tooltip message depending state and actions

Returns:toottip message Return type:str

update_data(key, new_value)

Update data of the wanted key

Parameters:

• key (str) – key to update
• new_value – new value of the key

History

History manage creation of history item for backend history endpoint

class alignak_app.items.history.History

Bases: alignak_app.items.item.Item

Class who create a history item

create(_id, data, name=None)

Create wanted item

Parameters:

• _id (str) – id of the item. Often equal to id in alignak backend
• data (dict | list) – data of the item
• name (str) – name of the item if available

static get_check_text(check_type)

Return text for check type :param check_type: type of check (active_checks_enabled or passive_checks_enabled) :type check_type: str :return: the corresponding text :rtype: str

static get_history_icon_name(message, event_type)

Return icon name related to message or event type

Parameters:

• message (str) – message of an history event
• event_type (str) – type of history event

Returns:

icon name

Return type:

str

static get_request_model()

Return the request model for history requests

Returns:request model for history endpoint Return type:dict

get_tooltip()

Return the tooltip message depending state and actions

Returns:toottip message Return type:str

update_data(key, new_value)

Update data of the wanted key

Parameters:

• key (str) – key to update
• new_value – new value of the key

Host

Host manage creation of host item for backend host endpoint

class alignak_app.items.host.Host

Bases: alignak_app.items.item.Item

Class who create a host item

create(_id, data, name=None)

Create wanted item

Parameters:

• _id (str) – id of the item. Often equal to id in alignak backend
• data (dict | list) – data of the item
• name (str) – name of the item if available

static get_available_icons()

Return list of available icons for a Host item

Returns:list of available icons for Host Return type:list

static get_check_text(check_type)

Return text for check type :param check_type: type of check (active_checks_enabled or passive_checks_enabled) :type check_type: str :return: the corresponding text :rtype: str

get_display_name()

Return alias or name if available

Returns:name or alias Return type:str

get_overall_tooltip(services)

Return corresponding overall state tooltip depends of _overall_state_id of Host and its Services

Parameters:services (list) – list of Service items Returns:overall tooltip message Return type:str

static get_request_model()

Return the request model for host requests

Returns:request model for host endpoint Return type:dict

get_tooltip()

Return the tooltip message depending state and actions

Returns:toottip message Return type:str

update_data(key, new_value)

Update data of the wanted key

Parameters:

• key (str) – key to update
• new_value – new value of the key

Live Synthesis

Live Synthesis manage creation of livesynthesis item for backend livesynthesis endpoint

class alignak_app.items.livesynthesis.LiveSynthesis

Bases: alignak_app.items.item.Item

Class who create livesynthesis item

create(_id, data, name=None)

Create wanted item

Parameters:

• _id (str) – id of the item. Often equal to id in alignak backend
• data (dict | list) – data of the item
• name (str) – name of the item if available

static get_check_text(check_type)

Return text for check type :param check_type: type of check (active_checks_enabled or passive_checks_enabled) :type check_type: str :return: the corresponding text :rtype: str

static get_request_model()

Return the request model for livesynthesis requests

Returns:request model for livesynthesis endpoint Return type:dict

static get_synthesis_count_model()

Return the synthesis count model

Returns:synthesis count model Return type:dict

get_tooltip()

Return the tooltip message depending state and actions

Returns:toottip message Return type:str

update_data(key, new_value)

Update data of the wanted key

Parameters:

• key (str) – key to update
• new_value – new value of the key

Period

Period manage creation of period item for backend timeperiod endpoint

class alignak_app.items.period.Period

Bases: alignak_app.items.item.Item

Class who create a period item

create(_id, data, name=None)

Create wanted item

Parameters:

• _id (str) – id of the item. Often equal to id in alignak backend
• data (dict | list) – data of the item
• name (str) – name of the item if available

static get_check_text(check_type)

Return text for check type :param check_type: type of check (active_checks_enabled or passive_checks_enabled) :type check_type: str :return: the corresponding text :rtype: str

get_display_name()

Return alias or name if available

Returns:name or alias Return type:str

static get_request_model()

Return the request model for timeperiod requests

Returns:request model for timeperiod endpoint Return type:dict

get_tooltip()

Return the tooltip message depending state and actions

Returns:toottip message Return type:str

update_data(key, new_value)

Update data of the wanted key

Parameters:

• key (str) – key to update
• new_value – new value of the key

Realm

Realm manage creation of realm item for backend realm endpoint

class alignak_app.items.realm.Realm

Bases: alignak_app.items.item.Item

Class who create a realm item

create(_id, data, name=None)

Create wanted item

Parameters:

• _id (str) – id of the item. Often equal to id in alignak backend
• data (dict | list) – data of the item
• name (str) – name of the item if available

static get_check_text(check_type)

Return text for check type :param check_type: type of check (active_checks_enabled or passive_checks_enabled) :type check_type: str :return: the corresponding text :rtype: str

get_display_name()

Return alias or name if available

Returns:name or alias Return type:str

static get_request_model()

Return the request model for realm requests

Returns:request model for realm endpoint Return type:dict

get_tooltip()

Return the tooltip message depending state and actions

Returns:toottip message Return type:str

update_data(key, new_value)

Update data of the wanted key

Parameters:

• key (str) – key to update
• new_value – new value of the key

Service

Service manage creation of service item for backend service endpoint

class alignak_app.items.service.Service

Bases: alignak_app.items.item.Item

Class who create a service item

create(_id, data, name=None)

Create wanted item

Parameters:

• _id (str) – id of the item. Often equal to id in alignak backend
• data (dict | list) – data of the item
• name (str) – name of the item if available

static get_available_icons()

Return list of available icons for a Service item

Returns:list of available icons for Service Return type:list

static get_check_text(check_type)

Return text for check type :param check_type: type of check (active_checks_enabled or passive_checks_enabled) :type check_type: str :return: the corresponding text :rtype: str

get_display_name()

Return alias or name if available

Returns:name or alias Return type:str

static get_request_model(host_id=None)

Return the request model for service requests

Parameters:host_id (str) – “_id” of host, needed to get only host services Returns:request model for service endpoint Return type:dict

static get_service_states_nb()

Return all service state in a dict with int() as zero

Returns:all service state with int() as zero Return type:dict

get_tooltip()

Return the tooltip message depending state and actions

Returns:toottip message Return type:str

update_data(key, new_value)

Update data of the wanted key

Parameters:

• key (str) – key to update
• new_value – new value of the key

User

User manage creation of user item

class alignak_app.items.user.User

Bases: alignak_app.items.item.Item

Class who create user item for backend user endpoint

create(_id, data, name=None)

Create wanted item

Parameters:

• _id (str) – id of the item. Often equal to id in alignak backend
• data (dict | list) – data of the item
• name (str) – name of the item if available

static get_check_text(check_type)

Return text for check type :param check_type: type of check (active_checks_enabled or passive_checks_enabled) :type check_type: str :return: the corresponding text :rtype: str

static get_request_model(token)

Return the request model for user requests

Parameters:token (str) – token of user Returns:request model for user endpoint Return type:dict

get_role()

Get user role

Returns:role of user Return type:str

get_tooltip()

Return the tooltip message depending state and actions

Returns:toottip message Return type:str

update_data(key, new_value)

Update data of the wanted key

Parameters:

• key (str) – key to update
• new_value – new value of the key

Utils

The Utils package contains classes and functions configurations

Settings

Settings manage configurations of Alignak-app

• settings.cfg: contains configurations of Alignak-app (stored in ALIGNAKAPP_USR_DIR)
• images.ini: contains all images names (stored in ALIGNAKAPP_APP_DIR)
• style.css: contains css of Alignak-app (stored in ALIGNAKAPP_APP_DIR)

class alignak_app.utils.config.Settings

Bases: object

Class who read and create configuration for Alignak-app

get_config(section, option, boolean=False)

Return global application configuration values

Parameters:

• section (str) – wanted configuration section
• option (str) – wanted configuration option
• boolean (bool) – define if velue is boolean or not

Returns:

configuration value

Return type:

str | bool

get_image(name)

Return the path of wanted image

Parameters:name (str) – name of image Returns:full path of image Return type:str

init_config()

Initialize configurations

init_css()

Init the css file and fill app_css

set_config(section, option, new_value)

Set an option in configuration file

Parameters:

• section (str) – section to edit
• option (str) – option to edit, corresponding to the wanted section
• new_value (str) – new value to set in place of old

alignak_app.utils.config.get_url_endpoint_from_icon_name(icon_name)

Return endpoint depending of “icon_name”

Parameters:icon_name (str) – naem of icon

alignak_app.utils.config.open_url(endpoint='login')

Open web browser on wanted endpoint

Parameters:endpoint (str) – endpoint of webui

Installer

Installer check and manage installation of Alignak-app

• Check ALIGNAKAPP_APP_DIR, ALIGNAKAPP_USR_DIR and ALIGNAKAPP_LOG_DIR folders
• Check required files for application and user
• Install configuration and daemon files for user

class alignak_app.utils.installer.Installer

Bases: object

Class who create and check: folders, files and environment variables for Alignak-App

check_environment(mode='start')

Assign fields to environment variables if they don’t exist

check_install_files()

Check Alignak-app files

Returns:if all files are present Return type:bool

check_install_folders()

Check Alignak-app folders

Returns:if all folders are present Return type:bool

check_installation(mode='start')

Check Alignak-app installation

check_user_installation()

Check user installation files

init_environment()

Assign environment variables to fields if they exists

install()

Install Alignak-app user files on system

System

System manage interactions with folders and files for Alignak-app

alignak_app.utils.system.file_executable(filename)

Make filename executable

Parameters:filename (str) – file to make executable

alignak_app.utils.system.install_file(origin_dir, dest_dir, filename)

Install (copy) filename from an origin folder to a destination folder

Parameters:

• origin_dir (str) – origin folder where file to copy is located
• dest_dir (str) – destination folder where file will be copied
• filename (str) – name of file to copy

alignak_app.utils.system.mkdir(folder)

Make wanted folder

Parameters:folder (str) – folder to create Returns:if creation is success or not Return type:bool

alignak_app.utils.system.read_config_file(cfg_parser, filename)

Read configuration file and assign it to configParser object

Parameters:

• cfg_parser (configparser.ConfigParser) – configparser object
• filename (str) – name of file to read

Returns:

corresponding filename if read is success

Return type:

str

alignak_app.utils.system.write_file(origin_dir, dest_dir, filename, formatted_var=None)

Write a file from an origiin to a destination, with formatted variables if needed

Parameters:

• origin_dir (str) – origin folder where file is located
• dest_dir (str) – destination folder where file will be located
• filename (str) – name of file to write
• formatted_var (tuple) – tuple of variable to format origin file

alignak_app.utils.system.write_rc_file(filename)

Write RC file to add autocompletion for Alignak-app

Parameters:filename (str) – name of file for autocompletion

Logs

Logs manage application logs directory and file who are created inside ALIGNAKAPP_LOG_DIR.

alignak_app.utils.logs.create_logger()

Create the logger for Alignak-App

Returns:the RootLogger of App Return type:logging.RootLogger

Time

Time manage time and date for Alignak-app

alignak_app.utils.time.get_current_time()

Return current formatted time

Returns:current time Return type:str

alignak_app.utils.time.get_date_fromtimestamp(timestamp)

Return formatted date string correspondig to timestamp

Parameters:timestamp (float) – time stamp Returns:formatted date Return type:str

alignak_app.utils.time.get_diff_since_last_timestamp(timestamp, unit=None)

Return the difference between given time stamp and current time

Parameters:

• timestamp (float) – a time stamp
• unit – if unit return only corresponding value

Returns:

time difference formatted

Return type:

str | int

alignak_app.utils.time.get_local_datetime(_date)

Return the local time from a datetime

Parameters:_date (datetime.datetime) – datetime to set to local time Returns:local date time Return type:datetime.datetime

alignak_app.utils.time.get_local_datetime_from_date(_date)

Return the local timestamp from date

Parameters:_date (str) – date to convert to datetime Returns:corresponding local datetime of date Return type:datetime.datetime

Locales

The Locales package contains classes to manage translation.

Locales

Locales manage localization of Alignak-app

alignak_app.locales.locales.init_localization()

Application localization

Returns:gettext translator method Return type:method

QObjects

The QObjects package contains PyQt5 classes of Alignak-app

App Main

App Main manage creation of QMainWindow for:

• Dock (Right part)
• Panel (Left part)

class alignak_app.qobjects.app_main.AppQMainWindow(parent=None)

Bases: PyQt5.QtWidgets.QMainWindow

Class who create QMainWindow of Alignak-app

initialize()

Initialize QMainWindow for App

mouseMoveEvent(event)

QWidget.mousePressEvent(QMouseEvent)

mousePressEvent(event)

QWidget.mousePressEvent(QMouseEvent)

showEvent(_)

showEvent(self, QShowEvent)

Dock

Dock manage creation of QWidget for Dock (Right part)

class alignak_app.qobjects.dock.DockQWidget(parent=None)

Bases: PyQt5.QtWidgets.QWidget

Class who create QWidgets for dock

initialize()

Initialize dock QWidget

Panel

Panel manage creation of QWidget for Panel (Left part)

class alignak_app.qobjects.panel.PanelQWidget(parent=None)

Bases: PyQt5.QtWidgets.QWidget

Class who manage Panel with Host and Services QWidgets

display_host()

Display and update HostQWidget

dragEnterEvent(event)

Override dragEnterEvent.

Parameters:event – event triggered when something enter

dragMoveEvent(event)

Override dragMoveEvent.

Only accept EventItem() objects who have Qt.UserRole

Parameters:event – event triggered when something move

dropEvent(event)

Override dropEvent.

Get dropped item data, create a new one, and delete the one who is in EventsQWidget

Parameters:event – event triggered when something is dropped

get_current_host()

Return current Host item with name in QLineEdit

Returns:current host Return type:alignak_app.items.host.Host

static get_tab_order()

Return tab order defined by user, else default order

Returns:tab order of App Return type:list

initialize()

Create the QWidget with its items and layout.

set_host_from_problems()

Set line search if sender() is instance of QPushButton from Problems QWidget

spy_host()

Spy host who is available in line_search QLineEdit

Alignak

The Alignak package contains QObjects to display global alignak data, including alignakdaemon and livesynthesis endpoints

Alignak

Alignak manage creation of QWidgets for general Alignak data, like:

• Daemons status: status of each daemons ( see StatusQDialog class)
• Backend connection: status of backend connection ( see TrayIcon class)
• User: data of current user (see User package)

class alignak_app.qobjects.alignak.alignak.AlignakQWidget(parent=None)

Bases: PyQt5.QtWidgets.QWidget

Class who display daemons status, backend connection and user informations

initialize()

Initialize QWidget

show_status_dialog()

Update and show StatusQDialog

show_user_widget()

Update and show ProfileQWidget

update_status()

Update daemons and backend status

update_status_btn(status)

Update status button, depending if “status_ok” is False or True

Parameters:status (bool) – current status of alignak daemons

Dashboard

Dashboard manage the creation of QWidgets to display number of:

• Each states of Hosts items
• Each states of Services items

class alignak_app.qobjects.alignak.dashboard.DashboardQWidget(parent=None)

Bases: PyQt5.QtWidgets.QWidget

Class who manage Host and Services resume QWidgets with number of:

• Hosts: UP, UNREACHABLE, DOWN
• Services: OK, WARNING, CRITICAL, UNKNWON, UNREACHABLE
• Hosts and services: NOT_MONITORED, ACKNOWLEDGED, DOWNTIMED

get_host_resume_widget()

Return Host resume QWidget

get_services_resume_widget()

Return Services resume QWidget

initialize()

Initialize QWidget

open_item_type_url(item_type)

Retrieve sender to send right endpoint to open_url() function for item type

Parameters:item_type (str) – type of item: hosts | services

update_dashboard()

Update number of items in dashboard

Livestate

Livestate manage creation fo QWidget to resume number of:

• Number of hosts monitored and in problem
• Number of services monitored and in problem
• Number of item monitored and in problems

class alignak_app.qobjects.alignak.livestate.LivestateQWidget

Bases: PyQt5.QtWidgets.QWidget

Class who display items livestate: hosts, services and number of problems

get_item_type_widget(item_type, problem_nb, total_nb)

Create and return QWidget with backend data

Parameters:

• item_type (str) – type of item: host, service, problem
• problem_nb (int) – number of problems for item type
• total_nb (int) – total number of item type

Returns:

widget with its data

Return type:

QWidget

initialize()

Initialize QWidget

paintEvent(_)

Override paintEvent to paint background

update_labels()

Update QLabels of QWidget

Problems

Problems manage creation of QWidgets to display problems found in Alignak backend:

class alignak_app.qobjects.alignak.problems.ProblemsQWidget(parent=None)

Bases: PyQt5.QtWidgets.QWidget

Class who create Problems QWidget

add_spied_host()

Add a host to spied hosts

get_btn_widget()

Return QWidget with spy and host synthesis QPushButtons

Returns:widget with spy and host button Return type:QWidget

get_current_user_role_item()

Return current selected item by Qt.UserRole

Returns:current selected item or None Return type:alignak_app.items.item.Item

get_search_widget()

Create and return the search QWidget

Returns:search QWidget Return type:QWidget

initialize(spy_widget)

Initialize QWidget and set SpyQWidget

Parameters:spy_widget (alignak_app.qobjects.events.spy.SpyQWidget) – instance of SpyQWidget to manage spy events

update_action_buttons()

Update status of action buttons and set current item for ActionsQWidget

update_problems_data(item_type='')

Update data of Problems QTableWidget and problems title

Parameters:item_type (str) – type of item to filter

Problems Table

Problems Table manage creation of QTableView to display problems found in Alignak backend:

• Hosts: DOWN, UNREACHABLE
• Services: WARNING, CRITICAL, UNKNOWN

class alignak_app.qobjects.alignak.problems_table.ProblemsQTableView(parent=None)

Bases: PyQt5.QtWidgets.QTableView

Class who create Problems QTableView to display each problem

static get_item_text(item)

Return item text depends if it’s a host or service

Parameters:item (alignak_app.items.host.Host | alignak_app.items.service.Service) – host or service item Returns:text of item Return type:str

static get_output_tableitem(item)

Return centered QTableWidgetItem with output

Parameters:item (alignak_app.items.host.Host | alignak_app.items.service.Service) – host or service item Returns:table item with text Return type:QStandardItem

get_tableitem(item)

Return centered QTableWidgetItem with problem

Parameters:item (alignak_app.items.host.Host | alignak_app.items.service.Service) – host or service item Returns:table item with text Return type:QStandardItem

update_view(problems_data)

Update QTableView model and proxy filter

Parameters:problems_data (dict) – problems found in database Returns:proxy filter to connect with line edit Return type:QSortFilterProxyModel

Status

Status manage creation of QDialog for daemons status

class alignak_app.qobjects.alignak.status.StatusQDialog(parent=None)

Bases: PyQt5.QtWidgets.QDialog

Class who create QWidget for Daemons status.

add_daemon_labels(daemon_item, line)

Add daemon QLabels to layout

Parameters:

• daemon_item (alignak_app.items.item_daemon.Daemon) – daemon item
• line (int) – current line of layout

add_daemon_titles_labels(line)

Add QLabels titles for daemons to layout

Parameters:line (int) – current line of layout

static daemon_is_problem(daemon_item)

Check Daemon Refresh and if daemon is alive. Send a message if needed

Parameters:daemon_item (alignak_app.items.daemon.Daemon) – Daemon item Returns:if daemon is a problem True, else False Return type:bool

init_daemons_labels(daemons)

Initialize the daemon QLabels for each daemons

Parameters:daemons (list) – list of daemon items

initialize()

Initialize QDialog

mouseMoveEvent(event)

QWidget.mousePressEvent(QMouseEvent)

mousePressEvent(event)

QWidget.mousePressEvent(QMouseEvent)

update_dialog()

Update StatusQDialog labels and return if all daemons are ok or not

Returns:if status of daemons is ok or not Return type:bool

Common

The Common package contains common QObjects for Alignak-app, used by several other QWidgets

Actions

Actions manage global QDialog’s for actions : Acknowledge and Downtime

class alignak_app.qobjects.common.actions.AckQDialog(parent=None)

Bases: PyQt5.QtWidgets.QDialog

Class who create Acknowledge QDialog for hosts/services

initialize(item_type, item_name, comment)

Initialize Acknowledge QDialog

Parameters:

• item_type (str) – type of item to acknowledge : host | service
• item_name (str) – name of the item to acknowledge
• comment (str) – the default comment of action

mouseMoveEvent(event)

QWidget.mousePressEvent(QMouseEvent)

mousePressEvent(event)

QWidget.mousePressEvent(QMouseEvent)

class alignak_app.qobjects.common.actions.ActionsQWidget(parent=None)

Bases: PyQt5.QtWidgets.QWidget

Class who create Actions QWidget

add_acknowledge()

Create AckQDialog and manage acknowledge

add_downtime()

Create DownQDialog and manage downtime

static can_submit_actions()

Return if user can trigger actions from App or not, depending if Web Service is set and reachable:

• If Web Service: if reachable, make actions are available else they are disabled
• If NOT Web Service: App will use backend API

Returns:if user can trigger actions Return type:bool

initialize(item)

Initialize Actions QWidget, with ack and downtime buttons

update_widget()

Update QWidget

class alignak_app.qobjects.common.actions.DownQDialog(parent=None)

Bases: PyQt5.QtWidgets.QDialog

Class who create Downtime QDialog for hosts/services

duration_to_seconds()

Return “duration” QTimeEdit value in seconds

Returns:“duration” in seconds Return type:int

handle_accept()

Check if end_time timestamp is not lower than start_time

initialize(item_type, item_name, comment)

Initialize Downtime QDialog

Parameters:

• item_type (str) – type of item to acknowledge : host | service
• item_name (str) – name of the item to acknowledge
• comment (str) – the default comment of action

mouseMoveEvent(event)

QWidget.mousePressEvent(QMouseEvent)

mousePressEvent(event)

QWidget.mousePressEvent(QMouseEvent)

Buttons

Buttons manage global QPushButtons

class alignak_app.qobjects.common.buttons.ToggleQWidgetButton(parent=None)

Bases: PyQt5.QtWidgets.QWidget

Class who create QWidget with “toggle” QPushButton inside.

initialize()

Initialize QWidget

is_checked()

Return “toggle_btn” state

Returns:QPushButton state Return type:bool

update_btn_state(state)

Update QPushButton state, ObjectName and StyleSheet

Parameters:state (bool) – current state of QPushButton

Dialogs

Dialogs manage global QDialogs

class alignak_app.qobjects.common.dialogs.EditQDialog(parent=None)

Bases: PyQt5.QtWidgets.QDialog

Class who create Edit QDialog to edit text in Alignak-app

accept_text()

Set Edit QDialog to Rejected or Accepted (prevent to patch for nothing)

get_text_widget()

Return text QWidget with QTextEdit

Returns:text QWidget Return type:QWidget

initialize(title, text)

Initialize QDialog for UserNotesQDialog

Parameters:

• title (str) – title of the QDialog
• text (str) – text to edit

class alignak_app.qobjects.common.dialogs.MessageQDialog(parent=None)

Bases: PyQt5.QtWidgets.QDialog

Class who create a Message QDialog to display texts in Alignak-app

get_message_widget(dialog, title, text)

Return colored message QWidget

Parameters:

• dialog (str) – type of dialog (‘text’ or ‘error’)
• title (str) – title of text to display
• text (str) – text to display

Returns:

message QWidget

Return type:

QWidget

initialize(widgettitle, dialog, title, text)

Initialize QDialog for PasswordDialog

Parameters:

• widgettitle (str) – title of the QDialog
• dialog (str) – type of dialog (‘text’ or ‘error’)
• title (str) – title of text to display
• text (str) – text to display

class alignak_app.qobjects.common.dialogs.ValidatorQDialog(parent=None)

Bases: PyQt5.QtWidgets.QDialog

Class who create Validator QDialog to edit text in Alignak-app with regexp to validate

accept_text()

Set Edit QDialog to Rejected or Accepted (prevent to patch for nothing)

check_text()

Valid email with QRegExpValidator and inform user

get_text_widget(regexp)

Return text QWidget with QTextEdit

Returns:text QWidget Return type:QWidget

initialize(title, text, regexp)

Initialize QDialog for ValidatorQDialog

Parameters:

• title (str) – title of the QDialog
• text (str) – text to edit
• regexp (str) – regular expression to validate

Frames

Frames manage global QFrames for Alignak-app

alignak_app.qobjects.common.frames.get_frame_separator(vertical=False)

Return a frame separator

Parameters:vertical (bool) – define if separator is vertical or horizontal Returns:frame separator Return type:QFrame

Labels

Labels manage global QLabels and QPixmaps

alignak_app.qobjects.common.labels.get_icon_item(item_type, problem_nb)

Return QPixmap with the corresponding image

Parameters:

• item_type (str) – type of item: host, service or problem
• problem_nb (int) – problem number

Returns:

QPixmap with corresponding image

Return type:

QPixmap

alignak_app.qobjects.common.labels.get_icon_pixmap(value, icons)

Return corresponding icon name in icons

Parameters:

• value (bool) – value of attribute
• icons (list) – pair of icons

Returns:

pixmap icon corresponding to value

Return type:

QPixmap

Widgets

Widgets manage global QWidgets

class alignak_app.qobjects.common.widgets.LogoQWidget

Bases: PyQt5.QtWidgets.QWidget

Class who manage creation of Logo QWidget

initialize(child_widget, title, exitapp)

Initialize QWidget

Parameters:

• child_widget (QWidget) – widget child of LogoQWidget, needed for action button and layout
• title (str) – title of widget
• exitapp (bool) – define if close button close application or just child QWidget

minimize()

Minimize QWidget

minimize_maximize()

Minimize / Maximize QWidget

paintEvent(_)

Override to apply “background-color” property of QWidget

alignak_app.qobjects.common.widgets.center_widget(widget)

Center QWidget

Parameters:widget (QWidget) – widget to center

alignak_app.qobjects.common.widgets.get_logo_widget(child_widget, title, exitapp=False)

Return LogoQWidget with alignak logo

Parameters:

• child_widget (QWidget) – widget child of LogoQWidget, needed for action button and layout
• title (str) – title of widget
• exitapp (bool) – define if close button close application or just child QWidget

Returns:

Logo QWidget with buttons and child QWidget

Return type:

QWidget

Events

The Events package contains QObjects to view events collected by the application, like notifications in history, hosts spied, actions performed by the user

Events

Events manage creation of QWidget for events

class alignak_app.qobjects.events.events.EventsQWidget

Bases: PyQt5.QtWidgets.QWidget

Class who create QWidget for events

add_event(event_type, msg, timer=False, host=None)

Add event to events list

Parameters:

• event_type (str) – the type of event: OK, DOWN, ACK, …
• msg (str) – message of event
• timer (bool) – timer to hide event at end of time
• host (None | str) – data of a host to set Qt.UserRole

event_exist(msg)

Check if event already displayed, move it to top and update tooltip. Only for EventItem who have a Qt.UserRole

Parameters:msg (str) – message of event Returns:if message exist or not in events QWidgetList Return type:bool

initialize()

Intialize QWidget

remove_event(item=None)

Remove item when user double click on an item

Parameters:item (EventItem) – item to remove, else remove the current row

remove_timer_event(event)

Remove EventItem with timer

Parameters:event (EventItem) – EventItem with timer

send_datamanager_events()

Add events stored in DataManager

alignak_app.qobjects.events.events.get_events_widget()

Return EventsQWidget instance

Returns:EventsQWidget instance Return type:alignak_app.qobjects.events.events.EventsQWidget

alignak_app.qobjects.events.events.init_event_widget()

Initialize the global EventsQWidget. Used for drag & drop and send events

alignak_app.qobjects.events.events.send_event(event_type, msg, timer=False, host=None)

Add event to Events QWidget (access function to make event sendable in whole application. Event type define icon color of EventItem.

• green: [OK, UP]
• blue: [UNKNOWN, INFO, SPY]
• orange: [WARNING, UNREACHABLE, WARN]
• red’: [DOWN, CRITICAL, ALERT]
• yellow: [ACK]
• yellow: [DOWNTIME]

Parameters:

• event_type (str) – type of event to send
• msg (str) – message of event
• timer (bool) – timer to hide event at end of time
• host (None | str) – _id of host

Event Item

Event item manage creation of QListWidgetItem for events

class alignak_app.qobjects.events.item.EventItem

Bases: PyQt5.QtWidgets.QListWidgetItem

Class who create an event QListWidgetItem

close_item()

Hide items when timer is finished

static get_event_type(data)

Return event type depending of data content

Parameters:data (dict) – data of backend item Returns:event type for item Return type:str

static get_icon(event_type)

Return name of icon event

Parameters:event_type (str) – type of event Returns:name of icon Return type:str

initialize(event_type, msg, timer=False, host=None)

Initialize QListWidgetItem

Parameters:

• event_type (str) – the type of event: OK, DOWN, ACK, …
• msg (str) – message of event
• timer (bool) – timer to hide event at end of time
• host (None | str) – _id of host. Only necessary if “be_spied” is True

Spy

Spy manage creation of QWidget to manage spied items

class alignak_app.qobjects.events.spy.SpyQWidget

Bases: PyQt5.QtWidgets.QWidget

Class who create QWidget for spied hosts

static get_hint_item()

Return an EventItem with a hint text

Returns:event item with hint text Return type:EventItem

initialize()

Intialize Spy QWidget

manage_host_events(row)

Manage spy events for a host, defined by current row of “spy_list_widget”

Parameters:row (int) – current row of “spy_list_widget”

remove_event()

Remove item when user double click on an item, update parent tab text

send_spy_events()

Send event messages for all hosts who are spied

update_parent_spytab()

Update the parent spy tab text

Spy List

Spy List manage creation of custom QListWidget for host items who are spied

class alignak_app.qobjects.events.spy_list.SpyQListWidget

Bases: PyQt5.QtWidgets.QListWidget

Class who create QListWidget for spied hosts

add_spy_host(host_id)

Add a host to spied list and create corresponding EventItem()

Parameters:host_id (str) – “_id” of host to spy

dragMoveEvent(event)

Override dragMoveEvent.

Only accept EventItem() objects who have a Qt.UserRole and not already in “spied_hosts”

Parameters:event – event triggered when something move

dropEvent(event)

Override dropEvent.

Get dropped item data, create a new one, and delete the one who is in EventsQWidget

Parameters:event – event triggered when something is dropped

Host

The Host package contains QObjects to display data of the backend host

Customs

Customs manage creation of QWidget to display custom variables of an host

class alignak_app.qobjects.host.customs.CustomsQWidget(parent=None)

Bases: PyQt5.QtWidgets.QWidget

Class who create Customs Qwidget for host

initialize()

Initialize Customs QWidget

mouseMoveEvent(event)

QWidget.mousePressEvent(QMouseEvent)

mousePressEvent(event)

QWidget.mousePressEvent(QMouseEvent)

paintEvent(_)

Override to apply “background-color” property of QWidget

update_customs(host_item)

Update customs QTableWidget with customs of host item

Parameters:host_item (alignak_app.items.host.Host) – Host item

History

History manage creation of QWidget to display history of a host

class alignak_app.qobjects.host.history.HistoryQWidget(parent=None)

Bases: PyQt5.QtWidgets.QWidget

Class who create the History QWidget for host

static get_event_type(event, hostname)

Return event type for history

Parameters:

• event (dict) – event of history
• hostname (str) – name of host attached to event

Returns:

the event type

Return type:

str

get_event_widget(hostname, event)

Return event QWidget with icon, event text and event message

Parameters:

• hostname (str) – name of host attached to event
• event (dict) – data of an event

Returns:

widget of event

Return type:

QWidget

static get_icon_label(event)

Return QWidget with corresponding icon to item state

Parameters:event (dict) – data of an event Returns:icon QWidget Return type:QWidget

initialize()

Initialize History QWidget

mouseMoveEvent(event)

QWidget.mousePressEvent(QMouseEvent)

mousePressEvent(event)

QWidget.mousePressEvent(QMouseEvent)

paintEvent(_)

Override to apply “background-color” property of QWidget

update_history_data(hostname, host_history)

Update data of history QTableWidget

Parameters:

• hostname (str) – name of the host
• host_history (History) – history of host

Host

Host manage creation of QWidget to display host data

class alignak_app.qobjects.host.host.HostQWidget(parent=None)

Bases: PyQt5.QtWidgets.QWidget

Class who create QWidget to display host data

get_actions_widget()

Return QWidget with actions buttons

Returns:widget with buttons Return type:QWidget

get_host_icon_widget()

Return QWidget with overall icon state and host name

Returns:widget with host name and icon Return type:QWidget

get_last_check_widget()

Return QWidget with last check data

Returns:widget with last check data Return type:QWidget

get_notes_output_widget()

Return QWidget with output and notes data

Returns:widget with host output and notes Return type:QWidget

get_variables_widget()

Return QWidget with host variables

Returns:widget with host variables Return type:QWidget

initialize()

Initialize QWidget

patch_data()

Display QDialog for patch

patch_host_checks(check_type, state)

Patch the host check: ‘active_checks_enabled’ | ‘passive_checks_enabled’

Parameters:

• check_type (str) – type of check: ‘active_checks_enabled’ | ‘passive_checks_enabled’
• state (bool) – state of Toggle button

set_data(host_item)

Set data of host and service

Parameters:host_item (alignak_app.items.host.Host) – the Host item

show_customs()

Update and show CustomsQWidget

show_history()

Update and show HistoryQWidget

update_host(host_item=None)

Update HostQWidget data and QLabels

Parameters:host_item (alignak_app.items.host.Host) – the Host item

Synthesis

Synthesis manage creation of QWidget for Host Synthesis view

class alignak_app.qobjects.host.synthesis.SynthesisQWidget(parent=None)

Bases: PyQt5.QtWidgets.QWidget

Class who manage Synthesis view with Host and Services QWidgets

create_line_search(hostnames_list)

Add all hosts to QLineEdit and set QCompleter

Parameters:hostnames_list (list) – list of host names

get_search_widget()

Create and return the search QWidget

Returns:search QWidget Return type:QWidget

initialize_synthesis()

Initialize Synthesis QWidget

update_synthesis(host, services, not_spied)

Update Synthesis QWidget with given host and services

Parameters:

• host (alignak_app.items.host.Host) – host item
• services (list) – list of services attached to host
• not_spied (bool) – define if host is spied or not

Login

The Login package contains QObjects to display connection windows, for login and server settings

Login

Login manage creation of QDialog for user login

class alignak_app.qobjects.login.login.LoginQDialog(parent=None)

Bases: PyQt5.QtWidgets.QDialog

Class who create login QDialog.

accept_login()

Accept Login or not if backend is connected

create_widget()

Create widget login

handle_proxy()

Handle Proxy QDialog display and set proxies for login

static handle_server()

Handle for Server QDialog and set alignak backend server settings

mouseMoveEvent(event)

QWidget.mousePressEvent(QMouseEvent)

mousePressEvent(event)

QWidget.mousePressEvent(QMouseEvent)

set_proxy_settings(proxy_password=None)

Set the proxy settings, with password if given

Parameters:proxy_password (str) – the pasword of proxy

showEvent(_)

QDialog.showEvent(QShowEvent)

Server

Server manage creation of QDialog for Alignak backend server settings

class alignak_app.qobjects.login.server.ServerQDialog(parent=None)

Bases: PyQt5.QtWidgets.QDialog

Class who create Server QDialog.

get_settings_widget()

Return the alignak settings QWidget

Returns:settings QWidget Return type:QWidget

initialize_dialog()

Initialize Server QDialog

mouseMoveEvent(event)

QWidget.mousePressEvent(QMouseEvent)

mousePressEvent(event)

QWidget.mousePressEvent(QMouseEvent)

Service

The Service package contains QObjects to display data of the backend service

Service

Service manage creation of QWidget to display service data

class alignak_app.qobjects.service.service.ServiceDataQWidget(parent=None)

Bases: PyQt5.QtWidgets.QWidget

Class who create QWidget with service data

get_actions_widget()

Return QWidget with actions buttons

Returns:widget with buttons Return type:QWidget

get_last_check_widget()

Return QWidget with last check data

Returns:widget with last check data Return type:QWidget

get_service_icon_widget()

Return QWidget with its icon and name

Returns:widget with icon and name Return type:QWidget

initialize()

Initialize QWidget

periodic_refresh()

Refresh QWidget periodically

update_widget(service)

Update ServiceDataQWidget

Parameters:service (alignak_app.core.models.service.Service) – Service item with its data

Services

Services manage creation of QWidget to display the services

class alignak_app.qobjects.service.services.ServicesQWidget(parent=None)

Bases: PyQt5.QtWidgets.QWidget

Class wo create services QWidget

add_filter_item(filter_item)

Add filter item to QListWidget

Parameters:filter_item (alignak_app.items.service.Service) – filter item (service)

filter_services(state)

Filter services with the wanted state

Parameters:state – state of service: OK, WARNING, NOT_MONITORED, DOWNTIME Returns:

initialize()

Initialize QWidget

set_filter_items(state)

Add filter items to QListWidget corresponding to “state”

Parameters:state (str) – state of service to filter

update_service_data()

Update ServiceDataqWidget

update_widget(services)

Update the QTreeWidget and its items

Parameters:services (list) – list of Services items

Number Services

Number Services manage creation of QWidget to display number of host services, for each state

class alignak_app.qobjects.service.services_dashboard.ServicesDashboardQWidget(parent=None)

Bases: PyQt5.QtWidgets.QWidget

Class who create QWidget number of services of a host

initialize()

Initialize QWidget

update_widget(services_items)

Update QWidget

Parameters:services_items (list) – list of Service items

Service Tree Item

Service Tree Item manage creation of QTreeWidgetItem(s) to store and display Service item data

class alignak_app.qobjects.service.tree_item.ServiceTreeItem(parent=None)

Bases: PyQt5.QtWidgets.QTreeWidgetItem

Class who create QTreeWidgetItem with service data

initialize(service_item)

Initialize the QTreeWidgetItem

Parameters:service_item (alignak_app.core.models.service.Service) – service item with its data

update_item()

Update QIcon of service

Systray

The Service package contains QObjects to display system tray icon (taskbar)

App TrayIcon

App TrayIcon manage the creation of QSystemTrayIcon for Alignak-app menus

class alignak_app.qobjects.systray.tray_icon.AppTrayIcon(icon, parent=None)

Bases: PyQt5.QtWidgets.QSystemTrayIcon

Class who create QMenu and QActions for QSystemTrayIcon (displayed in task bar)

add_about_menu()

Create and add to menu “about” QAction

add_alignak_menu()

Create and add to menu “app” QAction

add_quit_menu()

Create and add to menu “exit” QAction

add_reload_menu()

Create and add to menu “reload” QAction

add_webui_menu()

Create and add to menu “webui” QAction

build_menu()

Initialize and create each QAction of QMenu

check_connection()

Check periodically connection to Alignak backend

static quit_app()

Quit application and close all widgets handle by application

refresh_menus()

Refresh menu if needed

static reload_configuration()

Reload configuration

Threads

The Threads package contains QObjects who manage application QThreads

Backend Thread

Backend Thread manage creation of QThreads for backend requests

class alignak_app.qobjects.threads.thread.BackendQThread(name, data=None)

Bases: PyQt5.QtCore.QThread

Class who create a QThread to trigger requests

run()

Run the QThread. Trigger actions depending on the selected name

Thread Manager

Thread Manager manage BackendQThreads creations and their priority:

• low : threads that group the queries about the elements that change little
• normal: threads that group the queries on items that change often
• high: threads that group the queries made on the fly

class alignak_app.qobjects.threads.threadmanager.ThreadManager(parent=None)

Bases: PyQt5.QtCore.QObject

Class who create BackendQThreads periodically, to request on Alignak Backend endpoints

add_high_priority_thread(thread_name, data)

Launch a thread with higher priority (doesn’t wait launch_threads() function)

Parameters:

• thread_name (str) – name of priority thread
• data (dict) – data to give to thread for request

clean_threads()

Clean current BackendQThreads

fill_threads(thread_type)

Fill threads to launch for a specific thread type

Parameters:thread_type (str) – type of thread to fill

is_launched(thread_type, thread_name)

Returns if the thread name is already in the started threads type

Parameters:

• thread_type (str) – type of thread
• thread_name (str) – name of thread

Returns:

if thread is launched or not

Return type:

bool

launch_threads(thread_type=None)

Launch the next thread of the given type or launch all the next threads for each type

Parameters:thread_type (str) – type of thread to launch

stop_high_priority_threads()

Stop threads with high priority

stop_threads()

Stop all running BackendQThreads

User

The User package contains QObjects to display data of the backend user

User Options

User Options manage creation options of QDialogs for user notifications options

class alignak_app.qobjects.user.options.UserOptionsQDialog(parent=None)

Bases: PyQt5.QtWidgets.QDialog

Class who create options QDialog

get_notifications_widget(item_type, options)

Create QWidget with options and their icons

Parameters:

• item_type (str) – define item type for options: host or service
• options (list) – list of notification options

Returns:

QWidget with options and icons

Return type:

QWidget

static get_selected_options(item_type, options)

Return the options who are selected or not

Parameters:

• item_type (str) – type of item we want options
• options (list) – options for the wanted item type

Returns:

dict of options selected

Return type:

dict

initialize(item_type, options)

Initialize QDialog with App widget logo and options QWidget

Parameters:

• item_type (str) – define item type for options: host or service
• options (list) – list of notification options

alignak_app.qobjects.user.options.show_options_dialog(item_type, notification_options)

Show the UserOptionsQDialog

Parameters:

• item_type (str) – type of item we want options
• notification_options (list) – options for the wanted item type

Password

Password manage Qdialog for user password

class alignak_app.qobjects.user.password.PasswordQDialog(parent=None)

Bases: PyQt5.QtWidgets.QDialog

Class who create PasswordDialog QDialog

handle_confirm()

Handle accept_btn for password

initialize()

Initialize QDialog for PasswordDialog

Profile

Profile manage creation of QWidget who display user profile who use Alignak-app

class alignak_app.qobjects.user.profile.ProfileQWidget(parent=None)

Bases: PyQt5.QtWidgets.QWidget

Class who create QWidget for User profile.

enable_notifications(notification_type, btn_state)

Enable notification for the wanted type: hosts or services

Parameters:

• notification_type (str) – type of notifications (host or service)
• btn_state (bool) – state of sender button

get_hosts_notif_widget()

Create and return notification QWidget for hosts

Returns:hosts notification QWidget Return type:QWidget

get_informations_widget()

Create and return QWidget with user informations

Returns:main QWidget Return type:QWidget

get_notes_mail_widget()

Return QWidget with notes and email areas and edition buttons

Returns:notes and email QWidget Return type:QWidget

get_notifications_widget()

Create and return notification QWidget for hosts and services

Returns:notifications QWidget Return type:QWidget

get_services_notif_widget()

Create and return notification QWidget for services

Returns:services notification QWidget Return type:QWidget

initialize()

Initialize User QWidget

mouseMoveEvent(event)

QWidget.mousePressEvent(QMouseEvent)

mousePressEvent(event)

QWidget.mousePressEvent(QMouseEvent)

paintEvent(_)

Override to apply “background-color” property of QWidget

patch_data(patch_type)

Display QDialogs for patches

Parameters:patch_type (str) – type of patch (“notes” or “password”)

static show_token_dialog()

Show Token QDialog

update_widget()

Update UserQWidget

About

About

About manage creation of QDialog to display data about Alignak-app

class alignak_app.qobjects.about.AboutQDialog(parent=None)

Bases: PyQt5.QtWidgets.QDialog

Class who create QDialog to display about data

static get_external_link_label(link, title='')

Return QLabel with clickable text

Parameters:

• link (str) – link to make clickable
• title (str) – title of link

Returns:

QLabel with clickable link

Return type:

QLabel

initialize()

Initialize QDialog

show_about()

Show about dialog