From 5feea0f6dc5b54aa6b7030fc8cb3b5fcf6dfe932 Mon Sep 17 00:00:00 2001 From: arcan1s Date: Mon, 25 Aug 2014 16:05:45 +0400 Subject: [PATCH] update netctl-gui pages --- _posts/2014-05-18-disabling-baloo.html | 2 +- devs/netctl-gui-dbus-api.html | 380 ++++++++++++++++++ devs/netctl-gui-security-notes.html | 105 +++++ devs/netctl-gui/annotated.html | 11 +- devs/netctl-gui/class_netctl-members.html | 46 ++- devs/netctl-gui/class_netctl.html | 334 ++++++++++++--- .../class_netctl_profile-members.html | 17 +- devs/netctl-gui/class_netctl_profile.html | 41 +- devs/netctl-gui/class_sleep_thread.html | 228 ----------- devs/netctl-gui/class_sleep_thread.png | Bin 444 -> 0 bytes devs/netctl-gui/class_wpa_sup-members.html | 21 +- devs/netctl-gui/class_wpa_sup.html | 53 ++- devs/netctl-gui/classes.html | 20 +- .../dir_08d237fc27d4ecd563f71c5d52f2fecc.html | 6 +- .../dir_65c9e01252fc41f6e848ebca2af7e47b.html | 6 +- .../dir_e335b5ab077db6a8c30879452b1fc605.html | 6 +- .../dir_fe59a2a0e1774c507781b7be7e3787b8.html | 8 +- devs/netctl-gui/files.html | 9 +- devs/netctl-gui/functions.html | 95 +++-- devs/netctl-gui/functions_func.html | 69 ++-- devs/netctl-gui/functions_vars.html | 127 ++++++ devs/netctl-gui/hierarchy.html | 18 +- devs/netctl-gui/index.html | 6 +- devs/netctl-gui/netctlgui_8h.html | 6 +- devs/netctl-gui/netctlgui_8h_source.html | 15 +- devs/netctl-gui/netctlinteract_8h.html | 9 +- devs/netctl-gui/netctlinteract_8h_source.html | 161 ++++---- devs/netctl-gui/netctlprofile_8h.html | 6 +- devs/netctl-gui/netctlprofile_8h_source.html | 43 +- devs/netctl-gui/search/all_0.js | 2 + devs/netctl-gui/search/all_2.js | 3 +- devs/netctl-gui/search/all_3.js | 13 +- devs/netctl-gui/search/all_4.js | 7 +- devs/netctl-gui/search/all_5.js | 10 +- devs/netctl-gui/search/all_6.js | 10 +- devs/netctl-gui/search/all_7.js | 10 +- devs/netctl-gui/search/all_8.js | 10 +- devs/netctl-gui/search/all_9.js | 9 +- devs/netctl-gui/search/classes_0.js | 4 +- devs/netctl-gui/search/classes_1.js | 2 +- devs/netctl-gui/search/classes_2.js | 4 - devs/netctl-gui/search/files_1.js | 2 +- devs/netctl-gui/search/files_2.js | 4 - devs/netctl-gui/search/functions_0.js | 1 + devs/netctl-gui/search/functions_3.js | 11 +- devs/netctl-gui/search/functions_4.js | 14 +- devs/netctl-gui/search/functions_5.js | 6 +- devs/netctl-gui/search/functions_7.js | 1 + devs/netctl-gui/search/functions_8.js | 7 +- devs/netctl-gui/search/functions_9.js | 2 +- devs/netctl-gui/search/functions_a.js | 4 +- devs/netctl-gui/search/functions_b.js | 6 - devs/netctl-gui/search/search.js | 12 +- .../search/{files_2.html => variables_0.html} | 2 +- devs/netctl-gui/search/variables_0.js | 4 + .../{functions_b.html => variables_1.html} | 2 +- devs/netctl-gui/search/variables_1.js | 4 + .../{classes_2.html => variables_2.html} | 2 +- devs/netctl-gui/search/variables_2.js | 5 + devs/netctl-gui/search/variables_3.html | 26 ++ devs/netctl-gui/search/variables_3.js | 4 + devs/netctl-gui/search/variables_4.html | 26 ++ devs/netctl-gui/search/variables_4.js | 5 + devs/netctl-gui/sleepthread_8h_source.html | 147 ------- ...=> structnetctl_profile_info-members.html} | 17 +- .../netctl-gui/structnetctl_profile_info.html | 175 ++++++++ ...ml => structnetctl_wifi_info-members.html} | 45 +-- devs/netctl-gui/structnetctl_wifi_info.html | 190 +++++++++ devs/netctl-gui/wpasupinteract_8h.html | 9 +- devs/netctl-gui/wpasupinteract_8h_source.html | 105 +++-- projects/netctl-gui.html | 106 +++-- resources/screenshots/netctl-gui_about.png | Bin 20530 -> 27765 bytes .../screenshots/netctl-gui_dataengine.png | Bin 46211 -> 69749 bytes resources/screenshots/netctl-gui_main.png | Bin 52343 -> 36097 bytes .../screenshots/netctl-gui_netctl-auto.png | Bin 38020 -> 12638 bytes resources/screenshots/netctl-gui_plasmoid.png | Bin 117092 -> 183508 bytes .../netctl-gui_plasmoid_conf_01.png | Bin 59173 -> 67299 bytes .../netctl-gui_plasmoid_conf_02.png | Bin 45973 -> 54228 bytes .../netctl-gui_plasmoid_conf_03.png | Bin 46097 -> 49582 bytes resources/screenshots/netctl-gui_profile.png | Bin 43406 -> 38461 bytes resources/screenshots/netctl-gui_settings.png | Bin 20686 -> 37578 bytes resources/screenshots/netctl-gui_wifi.png | Bin 31820 -> 35275 bytes ru/projects/netctl-gui.html | 106 +++-- 83 files changed, 2047 insertions(+), 935 deletions(-) create mode 100644 devs/netctl-gui-dbus-api.html create mode 100644 devs/netctl-gui-security-notes.html delete mode 100644 devs/netctl-gui/class_sleep_thread.html delete mode 100644 devs/netctl-gui/class_sleep_thread.png create mode 100644 devs/netctl-gui/functions_vars.html delete mode 100644 devs/netctl-gui/search/classes_2.js delete mode 100644 devs/netctl-gui/search/files_2.js delete mode 100644 devs/netctl-gui/search/functions_b.js rename devs/netctl-gui/search/{files_2.html => variables_0.html} (93%) create mode 100644 devs/netctl-gui/search/variables_0.js rename devs/netctl-gui/search/{functions_b.html => variables_1.html} (93%) create mode 100644 devs/netctl-gui/search/variables_1.js rename devs/netctl-gui/search/{classes_2.html => variables_2.html} (93%) create mode 100644 devs/netctl-gui/search/variables_2.js create mode 100644 devs/netctl-gui/search/variables_3.html create mode 100644 devs/netctl-gui/search/variables_3.js create mode 100644 devs/netctl-gui/search/variables_4.html create mode 100644 devs/netctl-gui/search/variables_4.js delete mode 100644 devs/netctl-gui/sleepthread_8h_source.html rename devs/netctl-gui/{class_sleep_thread-members.html => structnetctl_profile_info-members.html} (74%) create mode 100644 devs/netctl-gui/structnetctl_profile_info.html rename devs/netctl-gui/{sleepthread_8h.html => structnetctl_wifi_info-members.html} (62%) create mode 100644 devs/netctl-gui/structnetctl_wifi_info.html diff --git a/_posts/2014-05-18-disabling-baloo.html b/_posts/2014-05-18-disabling-baloo.html index 2714914..9eb4fbc 100644 --- a/_posts/2014-05-18-disabling-baloo.html +++ b/_posts/2014-05-18-disabling-baloo.html @@ -9,7 +9,7 @@ short: disabling-baloo description: Paper, which describes how to remove the dependency on baloo in your system. ---

Disclaimer

-

I do not use this pacth, since I prefer less destructive methods. However, apparently all works fine, because there is no any claims. Since this patch was created in a few minutes, it removes all baloo's calls from source files (maybe I'll create a normal patch sometime).

+

I do not use this patch, since I prefer less destructive methods. However, apparently all works fine, because there is no any claims. Since this patch was created in a few minutes, it removes all baloo's calls from source files (maybe I'll create a normal patch sometime).

On other hand, I highly recommend to people, who do not use baloo for some reason, disable it from the settings menu (it was added it 4.13.1) or read this article.

diff --git a/devs/netctl-gui-dbus-api.html b/devs/netctl-gui-dbus-api.html new file mode 100644 index 0000000..6b4efce --- /dev/null +++ b/devs/netctl-gui-dbus-api.html @@ -0,0 +1,380 @@ + + + + netctl-gui DBus API desription + +

netctl-gui DBus API description

+

Project version : 1.3.0

+
    +
  1. DBus API
    2. +
  2. Helper API
    3. + +
  3. GUI API
    4. + +
  4. External links
    5. +
+ + + +

DBus API

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
methodresponcerun as root
org.netctlgui.helper service (system bus)
/ctrl path
bool Active()true if the helper is activeno
QString ApiDocs()returns path to this API documentationno
bool Close()true and closes the helperno
QStringList FindSettings()scans system and suggests the recommended configuration which will be used by the libraryno
QString LibraryDocs()returns path to the library documentationno
QString Pony()prints Pinkie Pie to stdout. Really, just tryno
QString SecurityDocs()returns path to the security documentationno
QStringList Settings()current helper settings KEY==VALUEno
QStringList UIDs()returns the helper process UIDs [UID, EUID]no
bool Update()calls update the helper configuration. Returns trueno
bool Enable(QString profile)enables or disables the profile. Returns true if action has been performed successfullyyes
bool forceStart(QString profile)force starts the profile. Returns true if action has been performed successfullyyes
bool forceStop(QString profile)force stops the profile. Returns true if action has been performed successfullyyes
bool Reenable(QString profile)reenables the profile. Returns true if action has been performed successfullyyes
bool Restart(QString profile)restarts the profile. Returns true if action has been performed successfullyyes
bool Start(QString profile)starts or stops the profile. Returns true if action has been performed successfullyyes
bool StopAll()stops all active profiles. Returns true if action has been performed successfullyyes
bool SwitchTo(QString profile)switchs to the profile. Returns true if action has been performed successfullyyes
bool Create(QString profile, QStringList settingsList)creates the profile with specified settings. Settings should be given in the format KEY==VALUE. Returns true if action has been performed successfullyyes
bool Remove(QString profile)removes the profile. Returns true if action has been performed successfullyyes
bool autoDisableAll()disables all profiles (netctl-auto). Returns true if action has been performed successfullyno?
bool autoEnable(QString profile)enables or disables the profile (netctl-auto). Returns true if action has been performed successfullyno?
bool autoEnableAll()enables all profiles (netctl-auto). Returns true if action has been performed successfullyno?
bool autoStart(QString profile)switchs to the profile (netctl-auto). Returns true if action has been performed successfullyno?
bool autoServiceEnable()enables or disables netctl-auto systemd service. Returns true if action has been performed successfullyyes
bool autoServiceRestart()restarts netctl-auto systemd service. Returns true if action has been performed successfullyyes
bool autoServiceStart()starts or stops netctl-auto systemd service. Returns true if action has been performed successfullyyes
QStringList WiFi()returns available WiFi points in format NAME|SECURITY|SIGNAL|ACTIVE|EXISTSyes
/netctl path
QString ActiveProfile()returns active profile from netctl or netctl-autono
QString ActiveProfileStatus()returns active profile status from netctl or netctl-auto. May be netctl-auto, active (enabled), active (static), inactive (enabled), inactive (static)no
QStringList Information()returns general information in format [ActiveProfile, ActiveProfileStatus]no
QStringList ProfileList()returns available profiles in format NAME|DESCRIPTION|ACTIVE|ENABLEDno
QStringList WirelessInterface()returns wireless interfacesno
bool isProfileActive(QString profile)returns true if the profile is activeno
bool isProfileEnabled(QString profile)returns true if the profile is enabledno
bool autoIsProfileActive(QString profile)returns true if the profile is active (netctl-auto)no
bool autoIsProfileEnabled(QString profile)returns true if the profile is enabled (netctl-auto)no
bool isNetctlAutoActive()returns true if netctl-auto is activeno
bool isNetctlAutoEnabled()returns true if netctl-auto is enabledno
QStringList Profile(QString profile)returns the profile settings in format KEY==VALUEno
QString ProfileByEssid(QString essid)returns the profile name by the given ESSID or empty lineno
QString ProfileValue(QString profile, QString key)returns value of the key by the given profile or empty lineno
org.netctlgui.netctlgui service (session bus)
/netctlgui path
bool Active()true if the application is activeno
void ApiDocs()opens this API documentationno
bool Close()true and closes the applicationno
QString Information()returns general information in format [ActiveProfile, ActiveProfileStatus]no
void LibraryDocs()opens the library documentationno
QString Pony()prints Pinkie Pie to stdout. Really, just tryno
bool Restore()true and restores the applicationno
void SecurityDocs()opens the security documentationno
QStringList Settings()current application settings KEY==VALUEno
bool ShowAbout()true and shows about windowno
bool ShowMain()true and shows main windowno
bool ShowNetctlAuto()true and shows netctl-auto windowno
bool ShowSettings()true and shows settings windowno
QStringList UIDs()returns the application process UIDs [UID, EUID]no
QStringList VerboseInformation()returns information in format [isNetctlAutoActive, ProfileList, ActiveProfile, isProfileEnabled/autoIsProfileEnabled]no
+ +

External links

+ + +

+ © 2014-2014 Evgeniy Alekseev
+ This software is licensed under GPLv3 +

+ + + diff --git a/devs/netctl-gui-security-notes.html b/devs/netctl-gui-security-notes.html new file mode 100644 index 0000000..fc9ac86 --- /dev/null +++ b/devs/netctl-gui-security-notes.html @@ -0,0 +1,105 @@ + + + + netctl-gui secutiry notes + +

netctl-gui security notes

+

Project version : 1.3.0

+
    +
  1. Description
    2. +
  2. Architecture
    3. +
  3. Library
    4. +
  4. Helper
    5. +
  5. Graphical interface
    6. +
  6. KDE components
    7. +
  7. External links
    8. +
+ + + +

Description

+

+ +

Architecture

+architecture + +

Library

+

According to the scheme the library gets information from netctl and can control it. Also it provides some additional functions such as a profile creation and removal and access to wpa_supplicant functions. Some functions do not require additional permissions, but other ones do it. All dynamic arguments including profile names and paths are in double quotes to avoid white spaces problem. The functions which require root privileges are:

+ + +

If library will be initialized with FORCE_SUDO=true than it will use sudo command (which can be transferred to the library by SUDO_PATH option). Otherwise it will try to set UID of children processes to 0. Please note that sudo command and UID setting will be used only for those commands which require it.

+ +

Profiles reading should be described. Since profiles has shell-like syntax some variables (which provide an array) cannot be reading by usual ways. To do it library uses bash:

+
+# define system variables
+env -i bash -c "set"
+# get profile and system variable list
+env -i bash -c "source '<profile>'; set"
+# get profile variables
+env -i bash -c "source '<profile>'; for i in ${!<key>[@]}; do echo ${<key>[$i]}; done"
+
+ +

Helper

+

First of all the helper does not interact with netctl directly, it uses the library to do it. So all library security notes are applicable here. To start the helper and to create DBus services user must be in network group by default (or must be root). But you may change it by editing $DBUS_SYSTEMCONF_PATH/org.netctlgui.helper.conf policy file (/etc/dbus-1/system.d/org.netctlgui.helper.conf by default). Please refer to DBus documentation to do it.

+ +

By default netctgui-helper binary has capabilities to set UID to the children processes (CAP_SETUID). If you do not want to get these capabilities you may use -DUSE_CAPABILITIES cmake flag. Please refer to man 7 capabilities for more details.

+ +

There are two configuration files $HOME/.config/netctl-gui.conf and /etc/netctl-gui.conf. The first one is a user configuration and the second one is a system-wide. Please note that by default user configuration has higher priority than system-wide, but running with --system flag user configuration will not be reading. The helper and GUI configurations are the same (although some keys aren't needed).

+ +

Graphical interface

+

Graphical interface may interact with netctl over DBus (the helper) and over the library. Please refer to their notes to any additional information. If user uses helper he should have permissions to run it.

+ +

KDE components

+

There are two netctl-based commands which are run from the DataEngine

+ +

Both of them do not require any additional privileges normally. Also DataEngine has two other command which will be run from; they should define external IP. According to the idea that user can set any command to run, this module is not secure. But running commands will not do more than user can do from console himself.

+ +

The widget gets information from DataEngine, thus it does not require any additional permissions to show information. But netctl calls are used to control netctl. In this case used commands are

+ +

All netctl-based commands require root privileges and sudo (and any other alternatives) is used normally as prefix to the commands. The netctl-auto command does not require additional permissions.

+ +

The other way is to use DBus communication with the helper. In this case user should have rights to start the helper.

+ +

External links

+ + +

+ © 2014-2014 Evgeniy Alekseev
+ This software is licensed under GPLv3 +

+ + + diff --git a/devs/netctl-gui/annotated.html b/devs/netctl-gui/annotated.html index f8ec508..e7f44ce 100644 --- a/devs/netctl-gui/annotated.html +++ b/devs/netctl-gui/annotated.html @@ -24,7 +24,7 @@ Logo
netctlgui -  1.2.0 +  1.3.0
Qt library which interacts with netctl
@@ -74,7 +74,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> - All Classes Files Functions + All Classes Files Functions Variables
@@ -92,14 +92,15 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); - - + + +
 CNetctlInteracts with netctl
 CNetctlProfileInteracts with netctl profiles
 CSleepThreadUsed for sleep current thread in WpaSup class
 CWpaSupInteracts with wpa_supplicant
 CnetctlProfileInfoNetctl profile information structure
 CnetctlWifiInfoWiFi information structure
 CWpaSupInteracts with wpa_supplicant
-Generated on Wed Jul 30 2014 19:20:33 for netctlgui by   +Generated on Mon Aug 25 2014 15:07:08 for netctlgui by   doxygen 1.8.7
diff --git a/devs/netctl-gui/class_netctl-members.html b/devs/netctl-gui/class_netctl-members.html index 337f97e..b8d678a 100644 --- a/devs/netctl-gui/class_netctl-members.html +++ b/devs/netctl-gui/class_netctl-members.html @@ -24,7 +24,7 @@ Logo
netctlgui -  1.2.0 +  1.3.0
Qt library which interacts with netctl
@@ -73,7 +73,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> - All Classes Files Functions + All Classes Files Functions Variables
@@ -95,31 +95,37 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); autoEnableAllProfiles()Netctlslot autoEnableProfile(const QString profile)Netctlslot autoEnableService()Netctlslot - autoIsProfileActive(const QString profile)Netctl - autoIsProfileEnabled(const QString profile)Netctl - autoRestartService()Netctlslot - autoStartProfile(const QString profile)Netctlslot - autoStartService()Netctlslot - enableProfile(const QString profile)Netctlslot - getInterfaceList()Netctl - getProfileDescription(const QString profile)Netctl - getProfileDescriptions(const QStringList profileList)Netctl - getProfileList()Netctl - getProfileListFromNetctlAuto()Netctl + autoGetActiveProfile()Netctl + autoIsProfileActive(const QString profile)Netctl + autoIsProfileEnabled(const QString profile)Netctl + autoRestartService()Netctlslot + autoStartProfile(const QString profile)Netctlslot + autoStartService()Netctlslot + enableProfile(const QString profile)Netctlslot + forceStartProfile(const QString profile)Netctlslot + forceStopProfile(const QString profile)Netctlslot + getActiveProfile()Netctl + getProfileDescription(const QString profile)Netctl + getProfileList()Netctl + getProfileListFromNetctlAuto()Netctl getProfileStatus(const QString profile)Netctl - getProfileStatuses(const QStringList profileList)Netctl - isNetctlAutoEnabled()Netctl - isNetctlAutoRunning()Netctl - isProfileActive(const QString profile)Netctl - isProfileEnabled(const QString profile)Netctl - Netctl(const bool debugCmd=false, const QMap< QString, QString > settings=QMap< QString, QString >())Netctlexplicit + getRecommendedConfiguration()Netctlstatic + getWirelessInterfaceList()Netctl + isNetctlAutoEnabled()Netctl + isNetctlAutoRunning()Netctl + isProfileActive(const QString profile)Netctl + isProfileEnabled(const QString profile)Netctl + Netctl(const bool debugCmd=false, const QMap< QString, QString > settings=QMap< QString, QString >())Netctlexplicit + reenableProfile(const QString profile)Netctlslot restartProfile(const QString profile)Netctlslot startProfile(const QString profile)Netctlslot + stopAllProfiles()Netctlslot + switchToProfile(const QString profile)Netctlslot ~Netctl()Netctl
-Generated on Wed Jul 30 2014 19:20:33 for netctlgui by   +Generated on Mon Aug 25 2014 15:07:08 for netctlgui by   doxygen 1.8.7
diff --git a/devs/netctl-gui/class_netctl.html b/devs/netctl-gui/class_netctl.html index 82fc667..d2d8f94 100644 --- a/devs/netctl-gui/class_netctl.html +++ b/devs/netctl-gui/class_netctl.html @@ -24,7 +24,7 @@ Logo
netctlgui -  1.2.0 +  1.3.0
Qt library which interacts with netctl
@@ -73,7 +73,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> - All Classes Files Functions + All Classes Files Functions Variables
@@ -87,6 +87,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
Public Slots | Public Member Functions | +Static Public Member Functions | List of all members
Netctl Class Reference
@@ -109,12 +110,27 @@ Public Slots bool enableProfile (const QString profile)  method which sets profile disabled or enabled More...
  +bool forceStartProfile (const QString profile) + method which force starts profile More...
+  +bool forceStopProfile (const QString profile) + method which force stops profile More...
+  +bool reenableProfile (const QString profile) + method which reenables profile More...
+  bool restartProfile (const QString profile)  method which restarts profile More...
  bool startProfile (const QString profile)  method which starts or stops profile More...
  +bool stopAllProfiles () + method which stops all profiles More...
+  +bool switchToProfile (const QString profile) + method which starts another profile More...
+  bool autoDisableAllProfiles ()  method which sets all profiles disabled (netctl-auto) More...
  @@ -145,27 +161,24 @@ Public Member Functions  ~Netctl ()  Netctl class destructor. More...
  -QStringList getInterfaceList () - method which gets interface list from PREFERED_IFACE and IFACE_DIR More...
-  -QList< QStringList > getProfileList () - method which returns profile informations from netctl More...
-  -QList< QStringList > getProfileListFromNetctlAuto () - method which returns profile informations from netctl-auto More...
-  +QStringList getActiveProfile () + method which returns active profile name More...
+  +QString autoGetActiveProfile () + method which returns active profile name from netctl-auto More...
+  +QList< netctlProfileInfo > getProfileList () + method which returns profile informations from netctl More...
+  +QList< netctlProfileInfo > getProfileListFromNetctlAuto () + method which returns profile informations from netctl-auto More...
+  QString getProfileDescription (const QString profile)  method which gets description from profile More...
  -QStringList getProfileDescriptions (const QStringList profileList) - method which gets descriptions from profile list More...
-  QString getProfileStatus (const QString profile)  method which gets profile status More...
  -QStringList getProfileStatuses (const QStringList profileList) - method which gets statuses of profile list More...
-  bool isProfileActive (const QString profile)  method which checks if profile is active More...
  @@ -184,6 +197,15 @@ Public Member Functions bool isNetctlAutoRunning ()  method which checks netctl-auto status More...
  +QStringList getWirelessInterfaceList () + method which gets wireless interface list from PREFERED_IFACE and IFACE_DIR More...
+  + + + + +

+Static Public Member Functions

static QMap< QString, QString > getRecommendedConfiguration ()
 method which check system configuration and return recommended values to keys More...
 

Detailed Description

The Netctl class interacts with netctl.

@@ -224,7 +246,7 @@ Public Member Functions
Parameters
- +
debugCmdshow debug messages
settingsdefault settings. Needed keys are IFACE_DIR (path to directory with interfaces), PREFERED_IFACE (prefered interface for WiFi), NETCTL_PATH (path to netctl command), NETCTLAUTO_PATH (path to netctl-auto command), NETCTLAUTO_SERVICE (netctl-auto service name), PROFILE_DIR (path to directory which contains profiles), SUDO_PATH (path to sudo command), SYSTEMCTL_PATH (path to systemctl command)
settingsdefault settings. Needed keys are FORCE_SUDO (force to use sudo), IFACE_DIR (path to directory with interfaces), PREFERED_IFACE (prefered interface for WiFi), NETCTL_PATH (path to netctl command), NETCTLAUTO_PATH (path to netctl-auto command), NETCTLAUTO_SERVICE (netctl-auto service name), PROFILE_DIR (path to directory which contains profiles), SUDO_PATH (path to sudo command), SYSTEMCTL_PATH (path to systemctl command)
@@ -366,6 +388,24 @@ true if the method was completed without errors
true if the method was completed without errors
+
+
+ +
+
+ + + + + + + +
QString Netctl::autoGetActiveProfile ()
+
+ +

method which returns active profile name from netctl-auto

+
Returns
profile name or ""
+
@@ -548,12 +588,82 @@ true if the method was completed without errors - + +
+
+ + + + + +
+ + + + + + + + +
bool Netctl::forceStartProfile (const QString profile)
+ 		+slot
+
+ +

method which force starts profile

+
Parameters
+ + +
profileprofile name
+
+
+
Returns
false if components are not found or command exit code is not equal to 0
+
+true if the method was completed without errors
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
bool Netctl::forceStopProfile (const QString profile)
+ 		+slot
+
+ +

method which force stops profile

+
Parameters
+ + +
profileprofile name
+
+
+
Returns
false if components are not found or command exit code is not equal to 0
+
+true if the method was completed without errors
+ +
+
+
- + @@ -561,8 +671,8 @@ true if the method was completed without errors
QStringList Netctl::getInterfaceList QStringList Netctl::getActiveProfile ( )
-

method which gets interface list from PREFERED_IFACE and IFACE_DIR

-
Returns
interface list. If PREFERED_IFACE is not empty it will be first element
+

method which returns active profile name

+
Returns
profile name or ""
@@ -591,37 +701,12 @@ true if the method was completed without errors - +
- - - - - - -
QStringList Netctl::getProfileDescriptions (const QStringList profileList)
-
- -

method which gets descriptions from profile list

-
Parameters
- - -
profileListprofile names
-
-
-
Returns
list of profile descriptions (if description is not available returns "")
- -
-
- -
-
- - - + @@ -630,16 +715,16 @@ true if the method was completed without errors

method which returns profile informations from netctl

-
Returns
list of profiles. Available information is [NAME, DESCRIPTION, STATUS]: NAME is a profile name, DESCRIPTION is a profile description (see more details below), STATUS is a profile status (see more details below)
+
Returns
list of profiles
- +
QList<QStringList> Netctl::getProfileList QList<netctlProfileInfo> Netctl::getProfileList ( )
- + @@ -648,7 +733,7 @@ true if the method was completed without errors

method which returns profile informations from netctl-auto

-
Returns
list of profiles. Available information is [NAME, DESCRIPTION, STATUS]: NAME is a profile name, DESCRIPTION is a profile description (see more details below), STATUS is a profile status (see more details below)
+
Returns
list of profiles from netctl-auto
@@ -677,28 +762,47 @@ true if the method was completed without errors - + +
+
+
QList<QStringList> Netctl::getProfileListFromNetctlAuto QList<netctlProfileInfo> Netctl::getProfileListFromNetctlAuto ( )
+ + + + +
+ + + + + + + +
static QMap<QString, QString> Netctl::getRecommendedConfiguration ()
+ 		+static
+
+ +

method which check system configuration and return recommended values to keys

+
Returns
recommended parametrs
+ +
+
+
- + - - +
QStringList Netctl::getProfileStatuses QStringList Netctl::getWirelessInterfaceList (const QStringList profileList))
-

method which gets statuses of profile list

-
Parameters
- - -
profileListprofile names
-
-
-
Returns
list of profile statuses. It may be "active (enabled)", "active (static)", "inactive (enabled)", "inactive (static)"
+

method which gets wireless interface list from PREFERED_IFACE and IFACE_DIR

+
Returns
interface list. If PREFERED_IFACE is not empty it will be first element
@@ -794,6 +898,41 @@ true if profile is active
true if profile is enabled
+ + + +
+
+ + + + + +
+ + + + + + + + +
bool Netctl::reenableProfile (const QString profile)
+ 		+slot
+
+ +

method which reenables profile

+
Parameters
+ + +
profileprofile name
+
+
+
Returns
false if components are not found or command exit code is not equal to 0
+
+true if the method was completed without errors
+
@@ -864,6 +1003,69 @@ true if the method was completed without errors
true if the method was completed without errors
+ + + +
+
+ + + + + +
+ + + + + + + +
bool Netctl::stopAllProfiles ()
+ 		+slot
+
+ +

method which stops all profiles

+
Returns
false if components are not found or command exit code is not equal to 0
+
+true if the method was completed without errors
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
bool Netctl::switchToProfile (const QString profile)
+ 		+slot
+
+ +

method which starts another profile

+
Parameters
+ + +
profileprofile name
+
+
+
Returns
false if components are not found or command exit code is not equal to 0
+
+true if the method was completed without errors
+
The documentation for this class was generated from the following file: -

- m -

- -

- n -

+

- f -

+ +

- g -

@@ -210,13 +225,6 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); -

- m -

- -

- n -