├── CHANGELOG.txt
├── README.md
├── bin
    ├── example_pb.xml
    ├── fritzbox.conf.php
    ├── fritzbox_diversity0on.php
    ├── fritzbox_get_foncallslist.php
    ├── fritzbox_guestlan_on_off.php
    ├── fritzbox_guestwlan_on_off.php
    ├── fritzbox_phonebook_export.php
    ├── fritzbox_phonebook_import.php
    ├── fritzbox_reboot.php
    ├── fritzbox_ring_phone.php
    └── fritzbox_tam_on_off.php
└── lib
    └── fritzbox_api.class.php


/CHANGELOG.txt:
--------------------------------------------------------------------------------
 1 | 0.5 2012-09-23
 2 | ---
 3 | 
 4 | * added doPostFile() to upload and download Files (for example the phonebook) to and from the box
 5 | * added sample script to reboot (thanks to godghost)
 6 | * added sample script to download/upload phonebook (CAUTION: the upload will overwrite your current phonebook)!
 7 | * restructured code in folders
 8 | 
 9 | 
10 | 0.4.1 2012-03-15:
11 | ---
12 | 
13 | * added a new script fritzbox_guestlan_on_off.php to switch the new Guest-LAN on and off
14 | * tested all builtin scripts with new FRITZ!OS 05.20
15 | 
16 | 
17 | 0.4 2011-05-15:
18 | ---
19 | 
20 | * added support for the new .lua forms like the WLAN guest access settings
21 | 
22 | 
23 | 0.3 2010-05-19:
24 | ---
25 | 
26 | * added a doGetRequest method in the API
27 | * some minor changes
28 | * a new module for downloading the foncalls list
29 | 
30 | 
31 | 0.2 2010-04-07:
32 | ---
33 | 
34 | * added a capability to use the Fritz!Box remote admin mode
35 |   Important limitation: does not check the certificate, so the password is sent to any computer responding at the configured address.
36 |   Feel free to hack the cURL calls to accept only a given certrificate
37 | 
38 | 
39 | 0.1:
40 | ---
41 | 
42 | * First release
43 | 
44 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # FritzBox! PHP API
 2 | 
 3 | Provides an interface to your FritzBox! using the webinterface. Thus, no modification the to firmware (aka FritzOS) is required!
 4 | 
 5 | ### Requirements
 6 | * PHP 5 (tested with 5.3)
 7 | * PHP-curl 
 8 | 
 9 | Install on Debian/Ubuntu: sudo apt-get install php5-cli php5-curl
10 | 
11 | ###Sample Scripts
12 | 
13 | * Enable/Disable TAM
14 | * Download Phone call list
15 | * Enable/Disable Guest (W)LAN
16 | * Ring a Phone
17 | * Reboot
18 | * Export the Phonebook
19 | * **Import the Phonebook (only tested with FB 71xx) [not available in the original version]**
20 | 
21 | **Newer Version available at**: [IPF discussion thread](http://www.ip-phone-forum.de/showthread.php?t=196309)
22 | 
23 | AUTHORS: [Gregor Nathanael Meyer](http://spackmat.de/spackblog), Karl Glatz, (maybe others)
24 | 
25 | ----------
26 | 
27 | ### Important! ###
28 | Do not use Windows Notepad as it will break the files due to their UTF-8 coding and UNIX linebreaks. Download a serious editor like Notepad++ instead.
29 | Also do not use or modify this scripts, if you do not know, what you do. This script is itended for advanced users
30 | 
31 | 
32 | 
33 | ### Basic usage advisory ####
34 | 
35 | The scripts are well documented, please take a look to understand them.
36 | This is also the right moment to check the config file "fritzbox.conf.php"!
37 | 
38 | All files must be in the same directory. If this condition is fulfilled, you don't need to pay any more attention to "fritzbox_api.class.php".
39 | 
40 | To use "fritzbox_tam_on_off.php", you have to call it in a terminal, it will then explain its usage. This script is a reference implementation of the PHP Fritz!Box API, use it as a base for your own implementations
41 | 
42 | 
43 | 
44 | ### Usage on a Windows system ###
45 | 
46 | The script works fine on my Windows Vista machine and a simply extraced PHP 5.3.0 distribution (get it at http://windows.php.net/download/, PHP 5.4.0 works as well). The cURL extension and the mbstring extenstion must be enabled in the php.ini and the correct timezone must be set. To do this, copy the php.ini-production to php.ini and uncomment/change the following directives:
47 | 
48 | extension_dir = "ext"
49 | extension=php_curl.dll
50 | extension=php_mbstring.dll
51 | date.timezone = Europe/Berlin
52 | 
53 | After you have done that, you can call the script in a terminal:
54 | 
55 |   C:\>path\to\php.exe path\to\fritzbox_tam_on_off.php
56 |   
57 | i.e. if you extracted PHP to c:\php and the Fritz!Box PHP API to a subfolder named fritz_api, you call it this way:
58 |   C:\>cd php
59 |   C:\php>php fritz_api\fritzbox_tam_on_off.php
60 |   
61 | If you use the Windows taskplanner, configure the logger to a logfile or to silent mode and call via php-win.exe instead of php.exe. This will prevent the terminal from being opened.
62 | 
63 |   
64 | 
65 | ### Usage on a UNIX system ###
66 | 
67 | If you use UNIX, you should be familiar with calling a PHP script via the PHP-CLI. If you don't have the PHP-CLI installed, you can edit the $argv part in "fritz_tam_on_off.php" to work with PHP-CGI and $_GET or you hardcode the necessary arguments.
68 | 
69 | Ensure that the cURL and the mbstring extensions are available and a valid timezone is set. The script was tested on a Ubuntu Server machine with PHP 5.2.
70 | 
71 | 
72 | 
73 | ### Feedback, license, support ###
74 | You are welcome to send me feedback via email (Gregor [at] der-meyer.de) or visit my personal blog at http://spackmat.de/spackblog (in German)
75 | 
76 | The whole work is licensed under a Creative Commons cc-by-sa license (http://creativecommons.org/licenses/by-sa/3.0/de/). You are free to use and modify it, even for commercial use. If you redistribute it, you have to ensure my name is kept in the code and you use the same conditions.
77 | 
78 | Feel free to add (and contribute) other nice scripts. The API class should work with any config item, which is available in the Fritz!Box Web UI. Use Firebug or LiveHeaders to figure out the name of the proper POST-Field.
79 | 
80 | I won't give any personal support for this script, unless you pay for it. :) I'm a freelance IT-consultant and webdeveloper, loocated in Düsseldorf, Germany.
81 | 


--------------------------------------------------------------------------------
/bin/example_pb.xml:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/carlos22/fritzbox_api_php/dfae25b28830cb797f42dbb8af80d6f356a1d15a/bin/example_pb.xml


--------------------------------------------------------------------------------
/bin/fritzbox.conf.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | #####################################################
 3 | #################### the config #####################
 4 | #####################################################
 5 | 
 6 | # set to your Fritz!Box IP address or DNS name (defaults to fritz.box), for remote config mode, use the dyndns-name like example.dyndns.org
 7 | $fritzbox_ip = 'fritz.box';
 8 | 
 9 | # if needed, enable remote config here
10 | #$enable_remote_config   = true;
11 | #$remote_config_user     = 'test';
12 | #$remote_config_password = 'test123';
13 | 
14 | # set to your Fritz!Box password (defaults to no password)
15 | $password    = false;
16 | 
17 | # set the logging mechanism (defaults to console logging)
18 | $logging     = 'console'; // output to the console
19 | #$logging     = 'silent';  // do not output anything, be careful with this logging mode
20 | #$logging     = 'tam.log'; // the path to a writeable logfile
21 | 
22 | # the newline character for the logfile (does not need to be changed in most cases) [note should be a constant!]
23 | $newline = PHP_EOL;
24 | // for pre php 5.0.2 use this:
25 | //$newline = (PHP_OS == 'WINNT') ? "\r\n" : "\n";
26 | 
27 | 
28 | 
29 | ############## module specific config ###############
30 | 
31 | # set the path for the call list for the foncalls module
32 | $foncallslist_path = dirname(__FILE__) . '/foncallsdaten.xml';
33 | $fonbook_import_path = dirname(__FILE__) . '/example_pb.xml';
34 | $fonbook_export_path = dirname(__FILE__) . '/exported_pb.xml';
35 | 


--------------------------------------------------------------------------------
/bin/fritzbox_diversity0on.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | // load the config
 3 | require_once('fritzbox.conf.php');
 4 |  
 5 | // load the fritzbox_api class
 6 | require_once('../lib/fritzbox_api.class.php');
 7 | 
 8 | $diversity = 0; // set to the interlan ID of the call diversion, the first one has ID 0;
 9 | $mode = 1; // set the mode to 0 or 1 do disable or enable the call diversion
10 | 
11 | // do the job
12 | try
13 | {
14 |   $fritz = new fritzbox_api($password, $fritzbox_ip);
15 |   
16 |   // update the setting
17 |   $formfields = array(
18 |     'getpage'                             => '../html/de/menus/menu2.html',
19 |     'telcfg:settings/Diversity' . $diversity . '/Active' => $mode,
20 |   );
21 |   $fritz->doPostForm($formfields);
22 |   $fritz = null; // destroy the object to log out
23 | }
24 | catch (Exception $e)
25 | {
26 |   echo $e->getMessage();
27 | }
28 | ?>
29 | 


--------------------------------------------------------------------------------
/bin/fritzbox_get_foncallslist.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Fritz!Box PHP tools CLI script to download the calllist from the Box
 4 |  *
 5 |  * Must be called via a command line, shows a help message if called without any or an invalid argument
 6 |  * Can log to the console or a logfile or be silent
 7 |  *
 8 |  * Check the config file fritzbox.conf.php!
 9 |  * 
10 |  * @author   Gregor Nathanael Meyer <Gregor [at] der-meyer.de>
11 |  * @license  http://creativecommons.org/licenses/by-sa/3.0/de/ Creative Commons cc-by-sa
12 |  * @version  0.1
13 |  * @package  Fritz!Box PHP tools
14 |  */
15 | 
16 | // load the config and the API class
17 | require_once(dirname(__FILE__) . '/fritzbox.conf.php');
18 | require_once(dirname(__FILE__) . '../lib/fritzbox_api.class.php');
19 | 
20 | function log_message($message)
21 | {
22 |   global $logging;
23 |   global $newline;
24 |   
25 |   if (!isset($logging) || (isset($logging) && $logging == 'console'))
26 |   {
27 |     echo $message;
28 |   }
29 |   else if (isset($logging) && $logging == 'silent')
30 |   {
31 |     // do nothing
32 |   }
33 |   else
34 |   {
35 |     file_put_contents($logging, $message . $newline, FILE_APPEND);
36 |   }
37 | }
38 | 
39 | // init the output message
40 | $message = date('Y-m-d H:i') . ' ';
41 | 
42 | 
43 | // handle the fritzbox_api class and do the job
44 | try
45 | {
46 |   if ( isset($enable_remote_config) && isset($remote_config_user) && isset($remote_config_password) )
47 |   {
48 |     $fritz = new fritzbox_api($password, $fritzbox_ip, true, $remote_config_user, $remote_config_password);
49 |   }
50 |   else
51 |   {
52 |     $fritz = new fritzbox_api($password, $fritzbox_ip);
53 |   }
54 |   
55 |   // get the frontend-page to refresh the list
56 |   $params = array(
57 |     'getpage'             => '../html/de/menus/menu2.html',
58 |     'var:menu'                => 'fon',
59 |     'var:pagename'        => 'foncalls',
60 |     'var:errorpagename'   => 'foncalls',
61 |     'var:type'            => '0',
62 |     //'telcfg:settings/UseJournal'  => '1',
63 |   );
64 |   $fritz->doPostForm($params);
65 |   
66 |   // get the phone calls list
67 |   $params = array(
68 |     'getpage'         => '../html/de/home/foncallsdaten.xml',
69 |     //'getpage'         => '../html/de/FRITZ!Box_Anrufliste.csv',
70 |   );
71 |   $output = $fritz->doGetRequest($params);
72 |   
73 |   // write out the call list to the desired path
74 |   file_put_contents($foncallslist_path, $output);
75 |   
76 |   // set a log message
77 |   $message .= 'Call list sucessfully downloaded';
78 |   
79 |   // destroy the object to log out
80 |   $fritz = null;
81 | }
82 | catch (Exception $e)
83 | {
84 |   $message .= $e->getMessage();
85 | }
86 | 
87 | // log the result
88 | log_message($message);
89 | ?>
90 | 


--------------------------------------------------------------------------------
/bin/fritzbox_guestlan_on_off.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Fritz!Box PHP tools CLI script to enable or disable the LAN4 guest access
  4 |  *
  5 |  * Must be called via a command line, shows a help message if called without any or an invalid argument
  6 |  * Can log to the console or a logfile or be silent
  7 |  *
  8 |  * Check the config file fritzbox.conf.php!
  9 |  * 
 10 |  * @author   Gregor Nathanael Meyer <Gregor [at] der-meyer.de>
 11 |  * @license  http://creativecommons.org/licenses/by-sa/3.0/de/ Creative Commons cc-by-sa
 12 |  * @version  0.1 2012-03-14
 13 |  * @package  Fritz!Box PHP tools
 14 |  */
 15 | 
 16 | // load the config
 17 | require_once('fritzbox.conf.php');
 18 |  
 19 | function log_message($message)
 20 | {
 21 |   global $logging;
 22 |   global $newline;
 23 |   
 24 |   if (!isset($logging) || (isset($logging) && $logging == 'console'))
 25 |   {
 26 |     echo $message;
 27 |   }
 28 |   else if (isset($logging) && $logging == 'silent')
 29 |   {
 30 |     // do nothing
 31 |   }
 32 |   else
 33 |   {
 34 |     file_put_contents($logging, $message . $newline, FILE_APPEND);
 35 |   }
 36 | }
 37 | 
 38 | // init the output message
 39 | $message = date('Y-m-d H:i') . ' ';
 40 | 
 41 | // handle the CLI arguments or give a help message
 42 | if (isset($argv[1]) && ($argv[1] == 0 || $argv[1] == 1) )
 43 | {
 44 |   $mode = (bool)$argv[1];
 45 | }
 46 | else
 47 | {
 48 |   if (!isset($logging) || (isset($logging) && $logging == 'console'))
 49 |   {
 50 |     echo '
 51 |     Enables or disables the LAN4 guest access of a Fritz!Box
 52 |     
 53 |     Usage on UNIX systems:
 54 |       /path/to/php ' .  $argv[0] . ' {0|1}
 55 |     
 56 |     Usage on Windows systems:
 57 |       "c:\path\to\php.exe" ' .  $argv[0] . ' {0|1}
 58 |     
 59 |     0 disables the guest access
 60 |     1 enables the guest access
 61 |     ';
 62 |   }
 63 |   else if (isset($logging) && $logging == 'silent')
 64 |   {
 65 |     // do nothing
 66 |   }
 67 |   else
 68 |   {
 69 |     log_message($message . 'ERROR: Script was called without or with an invalid argument');
 70 |   }
 71 |   exit;
 72 | }
 73 | 
 74 | 
 75 | // handle the fritzbox_api class and do the job
 76 | require_once('../lib/fritzbox_api.class.php');
 77 | try
 78 | {
 79 |   if ( isset($enable_remote_config) && isset($remote_config_user) && isset($remote_config_password) )
 80 |   {
 81 |     $fritz = new fritzbox_api($password, $fritzbox_ip, true, $remote_config_user, $remote_config_password);
 82 |   }
 83 |   else
 84 |   {
 85 |     $fritz = new fritzbox_api($password, $fritzbox_ip);
 86 |   }
 87 |   
 88 |   // read the current settings
 89 |   $formfields = array(
 90 |     'getpage' => '/net/network_settings.lua',
 91 |   );
 92 |   $output = $fritz->doGetRequest($formfields);
 93 |   
 94 |   
 95 |   // read time_server_activ setting
 96 |   preg_match('@name="time_server_activ"[^>]+(checked)[^>]*@', $output, $matches);
 97 |   if ( isset($matches[1]) )
 98 |   {
 99 |     $formfields['time_server_activ'] = 'on';
100 |   }
101 |   // read time_server setting
102 |   preg_match('@name="time_server"[^>]+value="([^"]*)"[^>]*@', $output, $matches);
103 |   $formfields['time_server'] = isset($matches[1]) ? $matches[1] : '0.europe.pool.ntp.org';
104 |   // read other_prefix_allowed setting
105 |   preg_match('@name="other_prefix_allowed"[^>]+(checked)[^>]*@', $output, $matches);
106 |   if ( isset($matches[1]) )
107 |   {
108 |     $formfields['other_prefix_allowed'] = 'on';
109 |   }
110 |   // read dnsv6_server_activ setting
111 |   preg_match('@name="dnsv6_server_activ"[^>]+(checked)[^>]*@', $output, $matches);
112 |   if ( isset($matches[1]) )
113 |   {
114 |     $formfields['dnsv6_server_activ'] = 'on';
115 |   }
116 |   
117 |   // set new given setting
118 |   if ( $mode == true )
119 |   {
120 |     $formfields['guest_enabled'] = 'on';
121 |   }
122 |   
123 |   // do the update
124 |   $formfields['btnSave'] = '';
125 |   $output = $fritz->doPostForm($formfields);
126 | 
127 |   preg_match('@name="guest_enabled"[^>]+(checked)[^>]*@', $output, $matches);
128 |   if ( isset($matches[1]) && $mode == true )
129 |   {
130 | 		$message .= 'LAN4 guest access is now active.';
131 |   }
132 |   else if ( !isset($matches[1]) && $mode == false )
133 |   {
134 |     $message .= 'LAN4 guest access is now inactive.';
135 |   }
136 |   else if ( isset($matches[1]) && $mode == false )
137 |   {
138 |     $message .= 'ERROR: LAN4 guest access status change failed, should be inactive, but is still active.';
139 |   }
140 |   else if ( !isset($matches[1]) && $mode == true )
141 |   {
142 |     $message .= 'ERROR: LAN4 guest access status change failed, should be active, but is still inactive.';
143 |   }
144 |   $fritz = null; // destroy the object to log out
145 | }
146 | catch (Exception $e)
147 | {
148 |   $message .= $e->getMessage();
149 | }
150 | 
151 | // log the result
152 | log_message($message);
153 | ?>
154 | 


--------------------------------------------------------------------------------
/bin/fritzbox_guestwlan_on_off.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Fritz!Box PHP tools CLI script to enable or disable the WLAN guest access
  4 |  *
  5 |  * Must be called via a command line, shows a help message if called without any or an invalid argument
  6 |  * Can log to the console or a logfile or be silent
  7 |  *
  8 |  * Check the config file fritzbox.conf.php!
  9 |  * 
 10 |  * @author   Gregor Nathanael Meyer <Gregor [at] der-meyer.de>
 11 |  * @license  http://creativecommons.org/licenses/by-sa/3.0/de/ Creative Commons cc-by-sa
 12 |  * @version  0.1 2011-06-15
 13 |  * @package  Fritz!Box PHP tools
 14 |  */
 15 | 
 16 | // load the config
 17 | require_once('fritzbox.conf.php');
 18 |  
 19 | function log_message($message)
 20 | {
 21 |   global $logging;
 22 |   global $newline;
 23 |   
 24 |   if (!isset($logging) || (isset($logging) && $logging == 'console'))
 25 |   {
 26 |     echo $message;
 27 |   }
 28 |   else if (isset($logging) && $logging == 'silent')
 29 |   {
 30 |     // do nothing
 31 |   }
 32 |   else
 33 |   {
 34 |     file_put_contents($logging, $message . $newline, FILE_APPEND);
 35 |   }
 36 | }
 37 | 
 38 | // init the output message
 39 | $message = date('Y-m-d H:i') . ' ';
 40 | 
 41 | // handle the CLI arguments or give a help message
 42 | if (isset($argv[1]) && ($argv[1] == 0 || $argv[1] == 1) )
 43 | {
 44 |   $mode = (bool)$argv[1];
 45 | }
 46 | else
 47 | {
 48 |   if (!isset($logging) || (isset($logging) && $logging == 'console'))
 49 |   {
 50 |     echo '
 51 |     Enables or disables the WLAN guest access of a Fritz!Box
 52 |     
 53 |     Usage on UNIX systems:
 54 |       /path/to/php ' .  $argv[0] . ' {0|1} [optional: PASSWORD]
 55 |     
 56 |     Usage on Windows systems:
 57 |       c:\path\to\php.exe ' .  $argv[0] . ' {0|1} [optional: PASSWORD]
 58 |     
 59 |     0 disables the guest access
 60 |     1 enables the guest access
 61 |     
 62 |     The optional argument PASSWORD sets a new guest access password (min 8 chars)
 63 |     Defaults to false, so the current password is kept.
 64 |     ';
 65 |   }
 66 |   else if (isset($logging) && $logging == 'silent')
 67 |   {
 68 |     // do nothing
 69 |   }
 70 |   else
 71 |   {
 72 |     log_message($message . 'ERROR: Script was called without or with an invalid argument');
 73 |   }
 74 |   exit;
 75 | }
 76 | $wpa_key = (isset($argv[2]) && strlen($argv[2]) >= 8 && strlen($argv[2]) <= 63) ? $argv[2] : false;
 77 | 
 78 | 
 79 | // handle the fritzbox_api class and do the job
 80 | require_once('../lib/fritzbox_api.class.php');
 81 | try
 82 | {
 83 |   if ( isset($enable_remote_config) && isset($remote_config_user) && isset($remote_config_password) )
 84 |   {
 85 |     $fritz = new fritzbox_api($password, $fritzbox_ip, true, $remote_config_user, $remote_config_password);
 86 |   }
 87 |   else
 88 |   {
 89 |     $fritz = new fritzbox_api($password, $fritzbox_ip);
 90 |   }
 91 |   
 92 |   // read the current settings
 93 |   $formfields = array(
 94 |     'getpage' => '/wlan/guest_access.lua',
 95 |   );
 96 |   $output = $fritz->doGetRequest($formfields);
 97 |   
 98 |   // read down_time_activ setting
 99 |   preg_match('@name="down_time_activ"[^>]+(checked)[^>]*@', $output, $matches);
100 |   if ( isset($matches[1]) )
101 |   {
102 |     $formfields['down_time_activ'] = 'on';
103 |   }
104 |   // read down_time_value setting
105 |   preg_match('@name="down_time_value".*?<option value="(\d+)"[^>]+?selected.*?</select>@s', $output, $matches);
106 |   $formfields['down_time_value'] = isset($matches[1]) ? $matches[1] : '15';
107 |   // read disconnect_guest_access setting
108 |   preg_match('@name="disconnect_guest_access"[^>]+(checked)[^>]*@', $output, $matches);
109 |   if ( isset($matches[1]) )
110 |   {
111 |     $formfields['disconnect_guest_access'] = 'on';
112 |   }
113 |   // read guest_ssid setting
114 |   preg_match('@name="guest_ssid"[^>]+value="([^"]*)"[^>]*@', $output, $matches);
115 |   $formfields['guest_ssid'] = isset($matches[1]) ? $matches[1] : 'defaultguestaccess';
116 |   // read wlan_security setting
117 |   preg_match('@name="wlan_security"[^>]+value="([^"])"[^>]+checked[^>]*@', $output, $matches);
118 |   $formfields['wlan_security'] = isset($matches[1]) ? $matches[1] : '15';
119 |   // read wpa_key setting
120 |   preg_match('@name="wpa_key"[^>]+value="([^"]*)"[^>]*@', $output, $matches);
121 |   $formfields['wpa_key'] = isset($matches[1]) ? $matches[1] : 'defaultwpakey';
122 |   // read wpa_modus setting
123 |   preg_match('@name="wpa_modus".*?<option value="(\d+)"[^>]+?selected.*?</select>@s', $output, $matches);
124 |   $formfields['wpa_modus'] = isset($matches[1]) ? $matches[1] : 'x';
125 |   
126 |   // set new given setting
127 |   if ( $mode == true )
128 |   {
129 |     $formfields['activate_guest_access'] = 'on';
130 |     if ( $wpa_key !== false )
131 |     {
132 |       $formfields['wpa_key'] = $wpa_key;
133 |     }
134 |   }
135 |   
136 |   // do the update
137 |   $formfields['btnSave'] = '';
138 |   $output = $fritz->doPostForm($formfields);
139 | 
140 |   preg_match('@name="activate_guest_access"[^>]+(checked)[^>]*@', $output, $matches);
141 |   if ( isset($matches[1]) && $mode == true )
142 |   {
143 | 		preg_match('@name="wpa_key"[^>]+value="([^"]*)"[^>]*@', $output, $matches);
144 | 		if ( isset($matches[1]) )
145 | 		{
146 | 			$message .= 'WLAN guest access is now active. WPA-Key is "' . $matches[1] . '"';
147 | 		}
148 |   }
149 |   else if ( !isset($matches[1]) && $mode == false )
150 |   {
151 |     $message .= 'WLAN guest access is now inactive.';
152 |   }
153 |   else if ( isset($matches[1]) && $mode == false )
154 |   {
155 |     $message .= 'ERROR: WLAN guest access status change failed, should be inactive, but is still active.';
156 |   }
157 |   else if ( !isset($matches[1]) && $mode == true )
158 |   {
159 |     $message .= 'ERROR: WLAN guest access status change failed, should be active, but is still inactive.';
160 |   }
161 |   $fritz = null; // destroy the object to log out
162 | }
163 | catch (Exception $e)
164 | {
165 |   $message .= $e->getMessage();
166 | }
167 | 
168 | // log the result
169 | log_message($message);
170 | ?>
171 | 


--------------------------------------------------------------------------------
/bin/fritzbox_phonebook_export.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | // load the config
 3 | require_once('fritzbox.conf.php');
 4 |  
 5 | // load the fritzbox_api class
 6 | require_once('../lib/fritzbox_api.class.php');
 7 | 
 8 | // do the job
 9 | try
10 | {
11 |   $fritz = new fritzbox_api($password, $fritzbox_ip);
12 |   $formfields = array(
13 | 			'PhonebookId' => '0',
14 | 			'PhonebookExportName' => 'Telefonbuch',
15 | 			'PhonebookExport' => ''
16 |   );
17 |   
18 |   $output = $fritz->doPostFile($formfields);
19 |   file_put_contents($fonbook_export_path, $output);
20 |   print "Phonebook exported to " . $fonbook_export_path . $newline;
21 |   
22 |   $fritz = null; // destroy the object to log out
23 | }
24 | catch (Exception $e)
25 | {
26 |   echo $e->getMessage();
27 | }
28 | ?>
29 | 


--------------------------------------------------------------------------------
/bin/fritzbox_phonebook_import.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | // load the config
 3 | require_once('fritzbox.conf.php');
 4 |  
 5 | // load the fritzbox_api class
 6 | require_once('../lib/fritzbox_api.class.php');
 7 | 
 8 | if (count($argv) < 2 || $argv[1] != "--overwrite") {
 9 | 	print "CAUTION: This will delete all current entries in your fritzbox phonebook";
10 | 	print $newline."call with ".$argv[0]." --overwrite".$newline;
11 | 	die();
12 | }
13 | 
14 | // do the job
15 | try
16 | {
17 |   $fritz = new fritzbox_api($password, $fritzbox_ip);
18 |   $formfields = array(
19 | 			'PhonebookId' => '0',
20 | 			'PhonebookImportFile' => '@'.$fonbook_import_path.';type=text/xml'
21 |   );
22 |   
23 |   
24 |   $output = $fritz->doPostFile($formfields);
25 |   
26 |   print "Phonebook imported from " . $fonbook_import_path . $newline;
27 |   
28 |   $fritz = null; // destroy the object to log out
29 | }
30 | catch (Exception $e)
31 | {
32 |   echo $e->getMessage();
33 | }
34 | ?>
35 | 


--------------------------------------------------------------------------------
/bin/fritzbox_reboot.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | // load the config
 3 | require_once('fritzbox.conf.php');
 4 |  
 5 | // load the fritzbox_api class
 6 | require_once('../lib/fritzbox_api.class.php');
 7 | 
 8 | // do the job
 9 | try
10 | {
11 |   $fritz = new fritzbox_api($password, $fritzbox_ip);
12 |   $formfields = array(
13 |     'getpage' => '/system/reboot.lua',
14 |   );
15 |   $output = $fritz->doGetRequest($formfields);
16 |   $formfields['reboot'] = '';
17 |   $output = $fritz->doPostForm($formfields);
18 |   $fritz = null; // destroy the object to log out
19 | }
20 | catch (Exception $e)
21 | {
22 |   echo $e->getMessage();
23 | }
24 | ?>
25 | 


--------------------------------------------------------------------------------
/bin/fritzbox_ring_phone.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | // load the config
 3 | require_once('fritzbox.conf.php');
 4 |  
 5 | // load the fritzbox_api class
 6 | require_once('../lib/fritzbox_api.class.php');
 7 | 
 8 | $dial = '**610'; // set to the number to dial
 9 | 
10 | // do the job
11 | try
12 | {
13 |   $fritz = new fritzbox_api($password, $fritzbox_ip);
14 |   
15 |   // update the setting
16 |   $formfields = array(
17 |     'getpage'                             => '../html/de/menus/menu2.html',
18 |     'telcfg:command/Dial'                 => $dial,
19 |   );
20 |   $fritz->doPostForm($formfields);
21 |   $fritz = null; // destroy the object to log out
22 | }
23 | catch (Exception $e)
24 | {
25 |   echo $e->getMessage();
26 | }
27 | ?>
28 | 


--------------------------------------------------------------------------------
/bin/fritzbox_tam_on_off.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Fritz!Box PHP tools CLI script to enable or disable answering machines
  4 |  *
  5 |  * Must be called via a command line, shows a help message if called without any or an invalid argument
  6 |  * Can log to the console or a logfile or be silent
  7 |  * new in v0.2: Can handle remote config mode via https://example.dyndns.org
  8 |  *
  9 |  * Check the config file fritzbox.conf.php!
 10 |  * 
 11 |  * @author   Gregor Nathanael Meyer <Gregor [at] der-meyer.de>
 12 |  * @license  http://creativecommons.org/licenses/by-sa/3.0/de/ Creative Commons cc-by-sa
 13 |  * @version  0.2
 14 |  * @package  Fritz!Box PHP tools
 15 |  */
 16 | 
 17 | // load the config
 18 | require_once('fritzbox.conf.php');
 19 |  
 20 | function log_message($message)
 21 | {
 22 |   global $logging;
 23 |   global $newline;
 24 |   
 25 |   if (!isset($logging) || (isset($logging) && $logging == 'console'))
 26 |   {
 27 |     echo $message;
 28 |   }
 29 |   else if (isset($logging) && $logging == 'silent')
 30 |   {
 31 |     // do nothing
 32 |   }
 33 |   else
 34 |   {
 35 |     file_put_contents($logging, $message . $newline, FILE_APPEND);
 36 |   }
 37 | }
 38 | 
 39 | // init the output message
 40 | $message = date('Y-m-d H:i') . ' ';
 41 | 
 42 | // handle the CLI arguments or give a help message
 43 | if (isset($argv[1]) && ($argv[1] == 0 || $argv[1] == 1) )
 44 | {
 45 |   $mode = (int)$argv[1];
 46 | }
 47 | else
 48 | {
 49 |   if (!isset($logging) || (isset($logging) && $logging == 'console'))
 50 |   {
 51 |     echo '
 52 |     Enables or disables an answering machine (TAM) of a Fritz!Box
 53 |     
 54 |     Usage on UNIX systems:
 55 |       /path/to/php ' .  $argv[0] . ' {0|1} [optional: TAM]
 56 |     
 57 |     Usage on Windows systems:
 58 |       c:\path\to\php.exe ' .  $argv[0] . ' {0|1} [optional: TAM]
 59 |     
 60 |     0 disable the TAM
 61 |     1 enable the TAM
 62 |     
 63 |     The optional argument TAM and addresses the nth answering machine
 64 |     Defaults to 0, which is the TAM **600; 1 is the TAM **601 and so on
 65 |     
 66 |     Warning: A non existent TAM will not lead to an error message but adds a
 67 |     new TAM to the Fritz!Box, which will answer all incoming calls by default!
 68 |     ';
 69 |   }
 70 |   else if (isset($logging) && $logging == 'silent')
 71 |   {
 72 |     // do nothing
 73 |   }
 74 |   else
 75 |   {
 76 |     log_message($message . 'ERROR: Script was called without or with an invalid argument');
 77 |   }
 78 |   exit;
 79 | }
 80 | $tam = (isset($argv[2]) && $argv[2] >= 0 && $argv[2] <= 9) ? (int)$argv[2] : 0;
 81 | 
 82 | 
 83 | // handle the fritzbox_api class and do the job
 84 | require_once('../lib/fritzbox_api.class.php');
 85 | try
 86 | {
 87 |   if ( isset($enable_remote_config) && isset($remote_config_user) && isset($remote_config_password) )
 88 |   {
 89 |     $fritz = new fritzbox_api($password, $fritzbox_ip, true, $remote_config_user, $remote_config_password);
 90 |   }
 91 |   else
 92 |   {
 93 |     $fritz = new fritzbox_api($password, $fritzbox_ip);
 94 |   }
 95 |   
 96 |   // update the setting
 97 |   $formfields = array(
 98 |     'getpage'                             => '../html/de/menus/menu2.html',
 99 |     'tam:settings/TAM' . $tam . '/Active' => $mode,
100 |   );
101 |   $fritz->doPostForm($formfields);
102 |   
103 |   // check if the update succeded
104 |   $formfields = array(
105 |     'getpage'         => '../html/de/menus/menu2.html',
106 |     'var:menu'        => 'home',
107 |     'var:pagemaster'  => 'fondevices',
108 |     'var:pagename'    => 'fondevices',
109 |   );
110 |   $output = $fritz->doPostForm($formfields);
111 |   
112 |   preg_match('@name="tam:settings/TAM' . $tam . '/Active" value="([10])"@i', $output, $matches);
113 |   if (isset($matches[1]) && $matches[1] == $mode)
114 |   {
115 |     $message .= $mode == 1 ? 'TAM' . $tam . ' enabled' : 'TAM' . $tam . ' disabled';
116 |   }
117 |   else if (isset($matches[1]))
118 |   {
119 |     $message .= 'ERROR: TAM' . $tam . ' status change failed, should be ' . $mode . ', but is ' . $matches[1];
120 |   }
121 |   else
122 |   {
123 |     $message .= 'NOTICE: TAM' . $tam . ' status change could have failed, should be ' . $mode . ' now, but I don\'t now if it actually is. Check your check section in the script.';
124 |   }
125 |   $fritz = null; // destroy the object to log out
126 | }
127 | catch (Exception $e)
128 | {
129 |   $message .= $e->getMessage();
130 | }
131 | 
132 | // log the result
133 | log_message($message);
134 | ?>
135 | 


--------------------------------------------------------------------------------
/lib/fritzbox_api.class.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Fritz!Box API - A simple wrapper for automatted changes in the Fritz!Box Web-UI
  4 |  * 
  5 |  * handles the new secured login/session system and implements a cURL wrapper
  6 |  * new in v0.2: Can handle remote config mode via https://example.dyndns.org
  7 |  * new in v0.3: New method doGetRequest handles GET-requests
  8 |  * new in v0.4: Added support for the new .lua forms like the WLAN guest access settings
  9 |  * 
 10 |  * @author   Gregor Nathanael Meyer <Gregor [at] der-meyer.de>
 11 |  * @license  http://creativecommons.org/licenses/by-sa/3.0/de/ Creative Commons cc-by-sa
 12 |  * @version  0.4 2011-05-15
 13 |  * @package  Fritz!Box PHP tools
 14 |  */
 15 | 
 16 | /* A simple usage example
 17 |  *
 18 |  * require_once('fritzbox_api.class.php');
 19 |  * try
 20 |  * {
 21 |  *   $fritz = new fritzbox_api('password', 'fritz-box');
 22 |  *   $formfields = array(
 23 |  *     'getpage'                  => '../html/de/menus/menu2.html', // the getpage parameter is mandatory
 24 |  *     'tam:settings/TAM0/Active' => 1, // enables the first answering machine, any POST-field from the Web-UI can be used
 25 |  *   );
 26 |  *   $fritz->doPostForm($formfields);   // send the command
 27 |  *   $fritz = null;                     // destroy the object to log out
 28 |  * }
 29 |  * catch (Exception $e)
 30 |  * {
 31 |  *   echo $e->getMessage();             // schow the error message in anything failed
 32 |  * }
 33 |  *
 34 |  */
 35 |  
 36 | /**
 37 |  * the main Fritz!Box API class
 38 |  *
 39 |  */
 40 | class fritzbox_api {
 41 |   /**
 42 |     * @var  string  the Fritz!Box password, set by the constructor
 43 |     */
 44 |   protected $password;
 45 |   
 46 |   /**
 47 |     * @var  bool    enable remote config mode, set by the constructor
 48 |     */
 49 |   protected $enable_remote_config;
 50 |   
 51 |   /**
 52 |     * @var  string  username for remote config mode, set by the constructor
 53 |     */
 54 |   protected $remote_config_user;
 55 |   
 56 |   /**
 57 |     * @var  string  password for remote config mode, set by the constructor
 58 |     */
 59 |   protected $remote_config_password;
 60 |   
 61 |   /**
 62 |     * @var  string  the Fritz!Box base URL, set by the constructor
 63 |     */
 64 |   protected $fritzbox_url;
 65 |   
 66 |   /**
 67 |     * @var  string  the session ID, set by method initSID() after login
 68 |     */
 69 |   protected $sid = '0000000000000000';
 70 |   
 71 |   
 72 |   /**
 73 |     * the constructor, initializes the object and calls the login method
 74 |     * 
 75 |     * @access public
 76 |     * @param  string $password                the Fritz!Box password, optional, defaults to null
 77 |     * @param  string $fritzbox_ip             the Fritz!Box IP address or DNS name, optional, defaults to fritz.box
 78 |     * @param  bool   $enable_remote_config    set true to enable remote config, optional, defaults to false
 79 |     * @param  string $remote_config_user      the remote config username, mandatory, if remote config is used
 80 |     * @param  string $remote_config_password  the remote config password, mandatory, if remote config is used
 81 |     */
 82 |   public function __construct($password = null, $fritzbox_ip = 'fritz.box', $enable_remote_config = false, $remote_config_user = null, $remote_config_password = null)
 83 |   {
 84 |     $this->password = $password;
 85 |     
 86 |     if ( $enable_remote_config === true )
 87 |     {
 88 |       if ( !isset($remote_config_user) || !isset($remote_config_password) )
 89 |       {
 90 |         $this->error('ERROR: Remote config mode enabled, but no username or no password provided');
 91 |       }
 92 |       $this->fritzbox_url            = 'https://' . $fritzbox_ip;
 93 |       $this->enable_remote_config    = true;
 94 |       $this->remote_config_user      = $remote_config_user;
 95 |       $this->remote_config_password  = $remote_config_password;
 96 |     }
 97 |     else
 98 |     {
 99 |       $this->fritzbox_url            = 'http://' . $fritzbox_ip;
100 |       $this->enable_remote_config    = false;
101 |       $this->remote_config_user      = null;
102 |       $this->remote_config_password  = null;
103 |     }
104 |     
105 |     $this->sid = $this->initSID();
106 |   }
107 |   
108 |   
109 |   /**
110 |     * the destructor just calls the logout method
111 |     * 
112 |     * @access public
113 |     */
114 |   public function __destruct()
115 |   {
116 |     $this->logout();
117 |   }
118 |   
119 |   
120 |   /**
121 |     * do a POST request on the box
122 |     * the main cURL wrapper handles the command
123 |     * 
124 |     * @access public
125 |     * @param  array  $formfields    an associative array with the POST fields to pass
126 |     * @return string                the raw HTML code returned by the Fritz!Box
127 |     */
128 |   public function doPostForm($formfields = array())
129 |   {  
130 |     $ch = curl_init();
131 |     if ( strpos($formfields['getpage'], '.lua') > 0 )
132 |     {
133 |       curl_setopt($ch, CURLOPT_URL, $this->fritzbox_url . $formfields['getpage'] . '?sid=' . $this->sid);
134 |       unset($formfields['getpage']);
135 |     }
136 |     else
137 |     {
138 |       // add the sid, if it is already set
139 |       if ($this->sid != '0000000000000000')
140 |       {
141 |         $formfields['sid'] = $this->sid;
142 |       }   
143 |       curl_setopt($ch, CURLOPT_URL, $this->fritzbox_url . '/cgi-bin/webcm');
144 |     }
145 |     curl_setopt($ch, CURLOPT_POST, 1);
146 |     if ( $this->enable_remote_config )
147 |     {
148 |       curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
149 |       curl_setopt($ch, CURLOPT_USERPWD, $this->remote_config_user . ':' . $this->remote_config_password);
150 |     }
151 |     curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($formfields));
152 |     curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
153 |     $output = curl_exec($ch);
154 |     curl_close($ch);
155 |     return $output;
156 |   }
157 |   
158 |     /**
159 |     * upload a file to the box (via POST) [all files are uploaded to the 'firmwarecfg' cgi-program] 
160 |     * the main cURL wrapper handles the command
161 |     * 
162 |     * @access public
163 |     * @param  array  $formfields    an associative array with the POST fields to pass
164 |     * @param  array  $filefileds    an associative array with the file data (key: content) and type (key: type)
165 |     * @return string                the raw HTML code returned by the Fritz!Box
166 |     */
167 |   public function doPostFile($formfields = array(), $filefileds = array())
168 |   {  
169 |     $ch = curl_init();
170 |    
171 |     // add the sid, if it is already set
172 |     if ($this->sid != '0000000000000000')
173 |     {
174 | 		// 'sid' MUST be the first POST variable!!! (otherwise it will not work!!)
175 | 		// therfore we use array_merge to ensuere the foreach outputs 'sid' fist
176 | 		$formfields = array_merge(array('sid' => $this->sid), $formfields);
177 | 		//$formfields['sid'] = $this->sid;
178 |     }   
179 |     curl_setopt($ch, CURLOPT_URL, $this->fritzbox_url . '/cgi-bin/firmwarecfg'); 
180 |     curl_setopt($ch, CURLOPT_POST, 1);
181 |     
182 |     // remote config?
183 |     if ( $this->enable_remote_config )
184 |     {
185 |       curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
186 |       curl_setopt($ch, CURLOPT_USERPWD, $this->remote_config_user . ':' . $this->remote_config_password);
187 |     }
188 |     
189 |     // enable for debugging:
190 |     //curl_setopt($ch, CURLOPT_VERBOSE, TRUE); 
191 |     curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
192 |     
193 |     // if filefileds not specified ('@/path/to/file.xml;type=text/xml' works fine)
194 |     if(empty( $filefileds )) {
195 | 		curl_setopt($ch, CURLOPT_POSTFIELDS, $formfields); // http_build_query
196 | 	} 
197 | 	// post calculated raw data
198 | 	else {
199 | 		$header = $this->_create_custom_file_post_header($formfields, $filefileds);
200 | 		curl_setopt($ch, CURLOPT_HTTPHEADER , array(
201 | 			'Content-Type: multipart/form-data; boundary=' . $header['delimiter'], 'Content-Length: ' . strlen($header['data']) )
202 | 			);
203 | 			
204 | 		curl_setopt($ch, CURLOPT_POSTFIELDS, $header['data']);		
205 | 	}
206 | 	
207 |     $output = curl_exec($ch);
208 | 
209 | 	// curl error
210 | 	if(curl_errno($ch)) {
211 | 		$this->error(curl_error($ch)." (".curl_errno($ch).")");
212 | 	}
213 | 
214 |     // finger out an error message, if given
215 |     preg_match('@<p class="ErrorMsg">(.*?)</p>@is', $output, $matches);
216 |     if (isset($matches[1]))
217 |     {
218 | 		$this->error(str_replace('&nbsp;', ' ', $matches[1]));
219 |     }
220 | 
221 |     curl_close($ch);
222 |     return $output;
223 |   }
224 |   
225 |   
226 |   private function _create_custom_file_post_header($postFields, $fileFields) {
227 | 		// form field separator
228 | 		$delimiter = '-------------' . uniqid();
229 | 		
230 | 		/*
231 | 		// file upload fields: name => array(type=>'mime/type',content=>'raw data')
232 | 		$fileFields = array(
233 | 			'file1' => array(
234 | 				'type' => 'text/xml',
235 | 				'content' => '...your raw file content goes here...',
236 | 				'filename' = 'filename.xml'
237 | 			),
238 | 		);
239 | 		// all other fields (not file upload): name => value
240 | 		$postFields = array(
241 | 			'otherformfield'   => 'content of otherformfield is this text',
242 | 		);
243 | 		*/
244 | 		
245 | 		$data = '';
246 | 
247 | 		// populate normal fields first (simpler)
248 | 		foreach ($postFields as $name => $content) {
249 | 		   $data .= "--" . $delimiter . "\r\n";
250 | 			$data .= 'Content-Disposition: form-data; name="' . urlencode($name) . '"';
251 | 			$data .= "\r\n\r\n";
252 | 			$data .= $content;
253 | 			$data .= "\r\n";
254 | 		}
255 | 		// populate file fields
256 | 		foreach ($fileFields as $name => $file) {
257 | 			$data .= "--" . $delimiter . "\r\n";
258 | 			// "filename" attribute is not essential; server-side scripts may use it
259 | 			$data .= 'Content-Disposition: form-data; name="' . urlencode($name) . '";' .
260 | 					 ' filename="' . $file['filename'] . '"' . "\r\n";
261 | 					 
262 | 			//$data .= 'Content-Transfer-Encoding: binary'."\r\n";
263 | 			// this is, again, informative only; good practice to include though
264 | 			$data .= 'Content-Type: ' . $file['type'] . "\r\n";
265 | 			// this endline must be here to indicate end of headers
266 | 			$data .= "\r\n";
267 | 			// the file itself (note: there's no encoding of any kind)
268 | 			$data .= $file['content'] . "\r\n";
269 | 		}
270 | 		// last delimiter
271 | 		$data .= "--" . $delimiter . "--\r\n";
272 | 	
273 | 		return array('delimiter' => $delimiter, 'data' => $data);
274 | 	}
275 |   
276 |   
277 |   
278 |   /**
279 |     * do a GET request on the box
280 |     * the main cURL wrapper handles the command
281 |     * 
282 |     * @access public
283 |     * @param  array  $params    an associative array with the GET params to pass
284 |     * @return string            the raw HTML code returned by the Fritz!Box
285 |     */
286 |   public function doGetRequest($params = array())
287 |   {
288 |     // add the sid, if it is already set
289 |     if ($this->sid != '0000000000000000')
290 |     {
291 |       $params['sid'] = $this->sid;
292 |     }    
293 |   
294 |     $ch = curl_init();
295 |     if ( strpos($params['getpage'], '.lua') > 0 )
296 |     {
297 |       $getpage = $params['getpage'] . '?';
298 |       unset($params['getpage']);
299 |     }
300 |     else
301 |     {
302 |       $getpage = '/cgi-bin/webcm?';
303 |     }
304 |     curl_setopt($ch, CURLOPT_URL, $this->fritzbox_url . $getpage . http_build_query($params));
305 |     curl_setopt($ch, CURLOPT_HTTPGET, 1);
306 |     if ( $this->enable_remote_config )
307 |     {
308 |       curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
309 |       curl_setopt($ch, CURLOPT_USERPWD, $this->remote_config_user . ':' . $this->remote_config_password);
310 |     }
311 |     curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
312 |     $output = curl_exec($ch);
313 |     curl_close($ch);
314 |     return $output;
315 |   }
316 |   
317 |   
318 |   /**
319 |     * the login method, handles the secured login-process
320 |     * newer firmwares (xx.04.74 and newer) need a challenge-response mechanism to prevent Cross-Site Request Forgery attacks
321 |     * see http://www.avm.de/de/Extern/Technical_Note_Session_ID.pdf for details
322 |     * 
323 |     * @access protected
324 |     * @return string                a valid SID, if the login was successful, otherwise throws an Exception with an error message
325 |     */
326 |   protected function initSID()
327 |   {
328 |     // read the current status
329 |     $ch = curl_init($this->fritzbox_url . '/cgi-bin/webcm?getpage=../html/login_sid.xml');
330 |     curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
331 |     if ( $this->enable_remote_config )
332 |     {
333 |       curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
334 |       curl_setopt($ch, CURLOPT_USERPWD, $this->remote_config_user . ':' . $this->remote_config_password);
335 |     }
336 |     $output = curl_exec($ch);
337 |     curl_close($ch);
338 |     $session_status_simplexml = simplexml_load_string($output);
339 |     
340 |     // perhaps we already have a SID (i.e. when no password is set)
341 |     if ($session_status_simplexml->iswriteaccess == 1)
342 |     {
343 |       return $session_status_simplexml->SID;
344 |     }
345 |     // we have to login and get a new SID
346 |     else
347 |     {
348 |       // the challenge-response magic, pay attention to the mb_convert_encoding()
349 |       $challenge = $session_status_simplexml->Challenge;
350 |       $response = $challenge . '-' . md5(mb_convert_encoding($challenge . '-' . $this->password, "UCS-2LE", "UTF-8"));
351 |       
352 |       // do the login
353 |       $formfields = array(
354 |         'getpage'                => '../html/de/menus/menu2.html',
355 |         'login:command/response' => $response,
356 |       );
357 |       $output = $this->doPostForm($formfields);
358 |       
359 |       // finger out an error message, if given
360 |       preg_match('@<p class="errorMessage">(.*?)</p>@is', $output, $matches);
361 |       if (isset($matches[1]))
362 |       {
363 |         $this->error(str_replace('&nbsp;', ' ', $matches[1]));
364 |       }
365 |       
366 |       // finger out the SID from the response
367 |       preg_match('@<input type="hidden" name="sid" value="([A-Fa-f0-9]{16})" id="uiPostSid">@i', $output, $matches);
368 |       if (isset($matches[1]) && $matches[1] != '0000000000000000')
369 |       {
370 |         return $matches[1];
371 |       }
372 |       else
373 |       {
374 |         $this->error('ERROR: Login failed with an unknown response');
375 |       }
376 |     }
377 |   }
378 |   
379 |   
380 |   /**
381 |     * the logout method just sends a logout command to the Fritz!Box
382 |     * 
383 |     * @access protected
384 |     */
385 |   protected function logout()
386 |   {
387 |     $formfields = array(
388 |       'getpage'                 => '../html/de/menus/menu2.html',
389 |       'security:command/logout' => 'logout',
390 |     );
391 |     $this->doPostForm($formfields);
392 |   }
393 |   
394 |   
395 |   /**
396 |     * the error method just throws an Exception
397 |     * 
398 |     * @access protected
399 |     * @param  string   $message     an error message for the Exception
400 |     */
401 |   protected function error($message = null)
402 |   {
403 |     throw new Exception("ERROR: ".$message."\n");
404 |   }
405 |   
406 |   
407 |   /**
408 |     * a getter for the session ID
409 |     * 
410 |     * @access public
411 |     * @return string                $this->sid
412 |     */
413 |   public function getSID()
414 |   {
415 |     return $this->sid;
416 |   }
417 | }
418 | 


--------------------------------------------------------------------------------