From b3e8feab0e0cbd4aa403b8e4907665f208c79ee9 Mon Sep 17 00:00:00 2001 From: Niklas Goby Date: Tue, 12 Apr 2011 18:38:15 +0200 Subject: added some comments in according to the doxigen conventions. Some todos are left due to less knowledge about the methods. edited classes are sysinfo and javascriptinterface --- src/sysinfo.cpp | 110 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 110 insertions(+) (limited to 'src/sysinfo.cpp') diff --git a/src/sysinfo.cpp b/src/sysinfo.cpp index 135db11..569fd06 100644 --- a/src/sysinfo.cpp +++ b/src/sysinfo.cpp @@ -2,10 +2,36 @@ // ------------------------------------------------------------------------------------------------ +/** + * A empty constructor. + */ SysInfo::SysInfo(){} // ------------------------------------------------------------------------------------------------ +/** + * A empty destructor. + */ SysInfo::~SysInfo(){} // ------------------------------------------------------------------------------------------------ +/** + * This method returns system informations. + * + * This method returns system informations according to the parameter. + * This method can be called from the JavascriptInterface class with the + * method JavascriptInterface::getSysInfo(const QString& info). + * + * @param infoName + * Is of type QString. Defines which method will be called. Possible values are: + * - mac + * - ip + * - mbserial + * - usb + * + * @return QString + * the output of the called method or "info_error" if an error occurred + * (e. g. invalid parameter). + * + * @see JavascriptInterface::getSysInfo(const QString& info) + */ const QString SysInfo::getInfo(const QString& infoName){ qxtLog->debug() << "[sysinfo] requested " << infoName; if (infoName == QString("mac")) @@ -25,6 +51,21 @@ const QString SysInfo::getInfo(const QString& infoName){ return "info_error"; } // ------------------------------------------------------------------------------------------------ +/** + * This method returns the clients MAC-Address. + * + * This method returns the clients MAC-Address of the "eth0" interface. + * The MAC-Address is used as part of the data to compute the + * hardwarehash of the client machine. To call this method use the + * SysInfo::getInfo(const QString& infoName) method with + * the parameter "mac" + * + * @return QString + * the MAC-Address or "no_eth0" if an error occurred. + * + * @see fbgui::generatePOSTData() + * @see SysInfo::getInfo(const QString& infoName) + */ const QString SysInfo::getMACAddress(){ // Returns MAC address of eth0 for now QNetworkInterface qni = QNetworkInterface::interfaceFromName(QString("eth0")); @@ -36,6 +77,19 @@ const QString SysInfo::getMACAddress(){ return qni.hardwareAddress(); } // ------------------------------------------------------------------------------------------------ +/** + * This method returns the clients IP-Address. + * + * This method returns the clients IP-Address of the "eth0" interface. + * To call this method use the + * SysInfo::getInfo(const QString& infoName) method with + * the parameter "ip" + * + * @return QString + * the IP-Address or "ip_error" if an error occurred. + * + * @see SysInfo::getInfo(const QString& infoName) + */ const QString SysInfo::getIPAddress(){ // Again for eth0 only at the moment. // TODO: this doesn't quite work yet... @@ -52,6 +106,9 @@ const QString SysInfo::getIPAddress(){ return "ip_error"; } // ------------------------------------------------------------------------------------------------ +/** + * just a test method for json. + */ const QByteArray SysInfo::getNames(){ QVariantMap foo; @@ -73,6 +130,9 @@ const QByteArray SysInfo::getNames(){ } // ------------------------------------------------------------------------------------------------ +/** + * just a test method for json. + */ QString SysInfo::getAllInfos(){ QVariantMap infos; infos.insert("mac", getMACAddress()); @@ -87,6 +147,22 @@ QString SysInfo::getAllInfos(){ return json; } // ------------------------------------------------------------------------------------------------ + +/** + * This method returns the Mainboard Serial Number. + * + * This method returns the Mainboard Serial Number. The mainboard serial + * number is used as part of the data to compute the hardwarehash of the + * client machine. To call this method use the + * SysInfo::getInfo(const QString& infoName) method with + * the parameter "mbserial" + * + * @return QString + * the mainboard serial or "mainboard_serial_error" if an error occurred. + * + * @see fbgui::generatePOSTData() + * @see SysInfo::getInfo(const QString& infoName) + */ const QString SysInfo::getMainboardSerial(){ QString out = ""; struct sysfs_class_device *class_device = sysfs_open_class_device("dmi","id"); @@ -109,6 +185,27 @@ const QString SysInfo::getMainboardSerial(){ return "mainboard_serial_error"; } // ------------------------------------------------------------------------------------------------ +/** + * This method returns inforamtions about connected usb devices. + * + * This method returns the inforamtions about connected usb devices + * as a json formated string. + * Those informations are: + * - the vendor + * - the vendorID + * - the product + * - the productID + * - the manufacturer + * - the serial number + * To call this method use the SysInfo::getInfo(const QString& infoName) + * method with the parameter "usb" + * + * @return QString + * all above described informations as a json formated string or "error" + * if an error occurred. + * + * @see SysInfo::getInfo(const QString& infoName) + */ const QString SysInfo::getUsbVendorIdProductIdSerialNumber() { QString tag = "[sysinfo] Usb Serial:"; @@ -180,6 +277,19 @@ const QString SysInfo::getUsbVendorIdProductIdSerialNumber() } // ------------------------------------------------------------------------------------------------ +/** + * This method returns the output of the provided script. + * + * This method returns the output of the provided script. + * Script could be any command. + * This method is not used so far. + * + * @param cmd + * Is of type QString. The command which will be executed + * + * @return QString + * output of the script. + */ QString SysInfo::getScriptOutput(QString cmd) { QProcess *process = new QProcess(); -- cgit v1.2.3-55-g7522