= v4.0.6 // tab-size of this document: 4 spaces // v1.57: error_reporting for debug-modes, debug-mode 5 extended // v1.571: debug-mode 5 extended again (3 outputs) // v1.572: fixed notice on E_STRICT about referencing method-return-values // v1.573: added another debug-output for not-existing function fsockopen() /** Disabling all error- (, warning-, and notice-) messages... * You may want to un-comment the following lines when testing or debugging this plugin. * At the end of the plugin you may restore the original reporting-level using the following call: * error_reporting( $linklift_saved_reporting_level ); * * Note: there is another call of error_reporting() in this plugin's method execute()! * * default: E_ERROR | E_WARNING | E_PARSE * all messages: E_ALL * only errors: E_ERROR * no messages: 0 * */ $linklift_saved_reporting_level = error_reporting(); // error_reporting( E_ALL ); /** * The LinkLift-website-key identifies your website on the LinkLift-marketplace. */ @define( "LL_WEBSITE_KEY" , "1829019a0N0" ); /** "LL_N02910a8019.xml" is the local XML-file used to store textlink-data * that has been downloaded from the LinkLift-Server. */ @define( "LL_TEXTLINK_DATAFILE" , "LL_N02910a8019.xml" ); /** The script-version-constants are used for checking * if a newer version of your plug-in is available on the LinkLift-server. * Note: the plug-in will not update itself, at this time. */ @define( "LL_PLUGIN_LANGUAGE" , "php" ); @define( "LL_PLUGIN_VERSION" , "1.573" ); @define( "LL_PLUGIN_DATE" , "2008-09-17" ); @define( "LL_PLUGIN_CREATION_DATE" , "20081024134435" ); @define( "LL_UPDATE_CHECK_TIMEFRAME" , "-1 week" ); @define( "LL_PLUGIN_SECRET_BASE" , "rMeE4BQNlU" ); @define( "LL_ONE_TIME_PASSWORD_ANSWER_TAG" , "linklift_onetime_answer" ); /** In order to not block the page-load-progrss * a time-limit (in seconds) is set when receiving new data from the LinkLift-server. */ @define( "LL_DATA_TIMEOUT" , 7 ); /** * The server-host to connect to in order to download data from LinkLift-server. */ @define( "LL_SERVER_HOST" , "external.linklift.net" ); @define( "LL_SERVER_URL" , "http://" . LL_SERVER_HOST . "/" ); @define( "LL_OPTION_PLUGIN_SECRET" , "linklift_plugin_secret" ); @define( "LL_PLUGIN_SECRET" , LL_PLUGIN_SECRET_BASE ); // if the plugin's individual "secret" is delivered the plugin's so-called SECRET-MODE is entered. Necessary for entering the plugin's DEBUG_MODE. if ( ( (! empty($_REQUEST["ls"])) && (LL_PLUGIN_SECRET === $_REQUEST["ls"]) ) || ( (! empty($_SERVER["REQUEST_URI"])) && (preg_match('@ls.' . LL_PLUGIN_SECRET . '@', $_SERVER["REQUEST_URI"])) ) ) { @define( "LL_SECRET_MODE" , true ); } else { @define( "LL_SECRET_MODE" , false ); } //if-else /** a possible debug-mode helping to analyse problems and functionality of the plugin * existing LL_DEBUG_MODEs: * 1: Display internal testlink with maximum length and umlauts * 2: Display the object's / plugin's current data / state * 3: Display the current XML-cache * 4: Displays some "internal values" like values of LinkLift-constants or the surrounding CMS' resolved language. * 5: Update the XML-cache (externally forced update), displays how much data has been received from the LinkLift-server (debugging connection-problems) * 10: Displays the running script's filename * 99: Known debug-modes */ if ( (LL_SECRET_MODE) && ( ( (! empty($_REQUEST["ld"])) && (is_numeric($_REQUEST["ld"])) ) || ( (! empty($_SERVER["REQUEST_URI"])) && (preg_match('@ld.(\d\d?)@', $_SERVER["REQUEST_URI"], $debug_mode_matches)) ) ) ) { if (isset($debug_mode_matches[1])) @define( "LL_DEBUG_MODE" , $debug_mode_matches[1] ); else @define( "LL_DEBUG_MODE" , $_REQUEST["ld"] ); } else { @define( "LL_DEBUG_MODE" , false ); } //if-else if (! class_exists("LinkLiftPlugin")) { class LinkLiftPlugin { // A LinkLift-website-key other than the class' constant LL_WEBSITE_KEY that should be used for updating the locally cached XML-data. var $linklift_website_key; // A XML-filename other then the class' constant above. This property will have no effect if your plugin uses a local database for caching. var $xml_filename = ""; // An array of integers representing the textlinks of the current textlink-data-array that should be generated and printed. You may want to use this property in order to distribute your textlinks on different locations of your website, to give an example. E.g: $links_to_show = array(1,3,5,7,9). var $links_to_show; // the current XML-cache var $xml_cache; // the last time the XML-cache has been updated var $xml_cache_time; // other variables, mainly copying linklift-constants var $data_timeout = LL_DATA_TIMEOUT; var $plugin_language = LL_PLUGIN_LANGUAGE; var $plugin_version = LL_PLUGIN_VERSION; var $plugin_date = LL_PLUGIN_DATE; var $plugin_creation_date = LL_PLUGIN_CREATION_DATE; /** * Usually, instances of the LinkLift-plugin's class do not need an (individual) state. * Thus, in general, we will need at most one instance of the plugin-class in order to generate HTML-output out of external data (XML-textlink-data). * * The class-method will always return the same object (singleton) or create a new one for you if none exists. * * Note: Since the method returns a reference you have to de-reference the result; e.g.: * $new_instance =& LinkLiftPlugin::getInstance(); * * @author akniep (Andreas Rayo Kniep) * @since 2007-10-26 * @return instance-reference on the class's singleton */ function &getInstance() { static $singleton; if ( (! is_object($singleton)) || (null == $singleton) || (empty($singleton->linklift_website_key)) ) { $singleton = new LinkLiftPlugin(); } //if return $singleton; } //getInstance() /** * Using the class' constructor you can obtain an instances of the LinkLift-plugin's having an individual state. * * @author akniep (Andreas Rayo Kniep) * @since 2007-10-26, 2007-12-10 * @param $linklift_website_key string, The LinkLift-website-key that should be used for updating the locally cached XML-data. If empty the method will use the default website-key that you can either find as a constant above or as value in your local database. Usually, this parameter is unused and empty! * @param $xml_filename string, The filename of the local XML-file that should be used for caching textlink-data iff your plugin does not use a local database for caching. If empty the method will use the default XML-filename that you can find as constant above. Usually, this parameter is unused and empty! * @param $links_to_show array, array of integers representing the textlinks of the current textlink-data-array that should be generated and printed by this instance. You may want to use this parameter in order to distribute your textlinks on different locations of your website, to give an example. E.g.: $links_to_show = array(0,2,4,6,8). Usually, this parameter is unused and empty! * @return LinkLiftPlugin, new instance of the LinkLift-plugin-class */ function LinkLiftPlugin( $linklift_website_key = "", $xml_filename = "", $links_to_show = array() ) { $instance_linklift_website_key = LinkLiftPlugin::resolve_website_key( $linklift_website_key ); if ( (empty($xml_filename)) && (defined("LL_TEXTLINK_DATAFILE")) ) { $xml_filename = LL_TEXTLINK_DATAFILE; } //if-else // saving instance-properties $this->setWebsiteKey( $instance_linklift_website_key ); $this->setXmlFilename( $xml_filename ); $this->setLinksToShow( $links_to_show ); } //__construct() /** * Resolves the LinkLift-Website-Key to use. * The website-key will be derived either from the surrounding CMS' database or from a constant set in this plugin. * Note: If you deliver a website-key this function will return it unchanged. * * class-method ("static") * * @author akniep (Andreas Rayo Kniep) * @since 2008-08-25 * @param $linklift_website_key string, You can deliver a website-key that will be returned by the function; default: empty (""). * @return string, the resolved linklift-website-key */ function resolve_website_key( $linklift_website_key = "" ) { if (empty($linklift_website_key)) { // plugin-specific saving and loading } //if return ( (! empty($linklift_website_key)) ? ($linklift_website_key) : (LL_WEBSITE_KEY) ); } //resolve_website_key() /** * This method creates an instance of class LinkLiftPlugin and invokes its main-function ll_textlink_code * in order to generate and output HTML-code with your textlinks (to standard-out) using the default linklift-website-key. * * This method wraps the calls of getInstance() and ll_textlink_code() and contains no further logic. * * class-method ("static") * * @author akniep (Andreas Rayo Kniep) * @since 2007-12-17, 2008-09-01 * @param $return boolean, Indicating whether the generated HTML-code should be returned ($return == true), or written to standard-out (echo); default: false. * @return void */ function execute( $return = false ) { if ( (function_exists("ini_set")) && (function_exists("ini_get")) ) { // eases debugging $linklift_saved_display_errors_value = @ini_get("display_errors"); @ini_set ("display_errors" , 1); } //if // displaying all error-messages while executing the desired method $linklift_saved_reporting_level = error_reporting(); // if in debug-mode we want to see all errors produced by this plugin if (LL_DEBUG_MODE) error_reporting( E_ALL ); // otherwise the plugin should not be fail due to CMS-errors or similar else error_reporting( 0 ); $linklift_plugin_instance =& LinkLiftPlugin::getInstance(); $textlink_code = $linklift_plugin_instance->ll_textlink_code( $return ); // restoring original error-reporting-level error_reporting( $linklift_saved_reporting_level ); // restoring original value of display_errors iff it has been changed before if ( (function_exists("ini_set")) && (function_exists("ini_get")) ) { @ini_set ("display_errors" , $linklift_saved_display_errors_value); } //if return $textlink_code; } //execute() /** * Detects and returns the given string's encoding using mb_detect_encoding. * class-method ("static") * * @author akniep (Andreas Rayo Kniep) * @since 2007-12-10 * @param $string string, the encoding of which should be deteceted. * @return string the detected encoding or an empty string of no encoding could have been detected. */ function ll_mb_detect_encoding( $string ) { if (function_exists("mb_detect_encoding")) return mb_detect_encoding( $string , $encoding_list = array( "UTF-8", "ISO-8859-1", "ISO-8859-15", "ASCII" ) ); else return ""; } //ll_mb_detect_encoding() /** * Calls a given string-function with the given * Unlike strtolower, this method tries to detect the given string's encoding (calling ll_mb_detect_encoding()) * and convert using mb_strtolower protecting special characters (e.g. umlauts). * * If the needed functions for detection and conversion are not available * strtolower is used in order to convert the given string. * class-method ("static") * * @author akniep (Andreas Rayo Kniep) * @since 2007-12-10 * @param $string_function string, (not callback!) the string-function to be either called directly or after prepending the "mb_"-prefix * @param $param_arr array, of parameters being passed to the $string_function, the first parameter is assumed to be the string to apply the $string_function to * @return mixed the result of the called $string_function or false if a faulty array of parameters was delivered */ function ll_call_str_function_encoding_dependent( $string_function, $param_arr ) { if ( (empty($param_arr)) || (! is_array($param_arr)) ) { return false; } //if if (function_exists("mb_" . $string_function)) { // the first given parameter is assumed to be the string to apply the $string_function to $string = $param_arr[0]; $string_encoding = LinkLiftPlugin::ll_mb_detect_encoding( $string ); if (! empty($string_encoding)) { $param_arr[] = $string_encoding; // calling the corresponding multibyte PHP-function return call_user_func_array("mb_" . $string_function, $param_arr); } //if } //if // calling the original PHP-function working with strings in ASCII-format return call_user_func_array($string_function, $param_arr); } //ll_call_str_function_encoding_dependent() /** * The method tries to connect to a given $server_host in order to open a server-socket-connection on port 80 * and write the given $request-string to it. * The given $request is expected to be a valid HTTP-request like typical GET- or POST-requests. * The data returned from the $server_host and received within a fixed timeframe will be returned. * The method is invoked by get_404_page() and ll_retrieve_xml_from_ll_server() or ll_send_ping_signal(), respectively (depending on your plugin-type). * class-method ("static") * * @author akniep (Andreas Rayo Kniep) * @since 2006-09-18, 2007-03-12, 2007-12-17 * @return $server_host string the host of the server to connect to and send the given $request to. * @return $request string the HTTP-request to be written to the server-socket-connection that is tried to be established with the given $server_host. * @return string the data received from the $server_host after writing the given $request to the opened server-socket-connection, or false if an error occurred. */ function get_page_content( $server_host, $request, $data_timeout = LL_DATA_TIMEOUT ) { if (! function_exists("fsockopen")) { if (LL_DEBUG_MODE) echo sprintf( "[LinkLift] Error: function fsockopen() does not exist. Probably, you are not allowed to use this PHP-function. Please contact your server-administrator." , $server, is_resource( $server ), $server_host, 80 ); return false; } //if if ( ($server = fsockopen($server_host, 80, $errno, $errstr, $data_timeout)) && (is_resource( $server )) ) { if (function_exists("stream_set_blocking")) stream_set_blocking($server, false); if (function_exists("stream_set_timeout")) stream_set_timeout( $server, $data_timeout ); else socket_set_timeout( $server, $data_timeout ); $connection_start_time = time(); $write_result = fwrite( $server, $request ); // unable to write to open socket. if (! $write_result) return false; $data = ""; while (! feof($server)) { $data_before = $data; $data .= fread($server, 10000); // if no data was received (yet) ... if ($data_before == $data) { // if no data was received and the the data-timout was reached // the download-process will be stopped. if ($data_timeout < time() - $connection_start_time) { $data = ""; break; } //if // ... go to sleep for 10 ms, waiting for data. // usleep() works on Linux-like servers! // On other systems usleep may have no effect // PHP 5.0.0 claims that usleep works on Windows-systems, as well ... // ... the effect on the system's processor, however, is not known to the writer. if (function_exists("usleep")) usleep($micro_seconds = 10 * 1000); // 10 * 1000 micro seconds = 10 milli seconds = 0.01 seconds } //if } //while fclose($server); if (5 == LL_DEBUG_MODE) echo sprintf( "[LinkLift] Debug (%s): Received %s bytes of data from %s:%s using fsockopen(), fwrite(), and fread()." , LL_DEBUG_MODE, strlen($data), $server_host, 80 ) . "\n" . $data; return $data; } else { if (LL_DEBUG_MODE) echo sprintf( "[LinkLift] Error: fsockopen() does not work properly (%s,%s,%s:%s). Maybe you are not allowed to use this PHP-function; Maybe our IP-address is blocked or not allowed to be accessed by/from your server. Please contact your server-administrator." , $server, is_resource( $server ), $server_host, 80 ); return false; } //if-else } //get_page_content() /** * Downloads the current-plugin-info for the installed plugin from the LinkLift-server. * The method will return an associative array of plugin_data containing (at least) the following fields: * - plugin-version: the current plugin-version of the delivered plugin-language on the LinkLift-server * - plugin-date: the rlease-date of the current plugin-version * - plugin-language: the plugin-language of the plugin-version * * class-method ("static") * * @author akniep (Andreas Rayo Kniep) * @since 2008-02-16 * @return $cms_info string additional CMS-info to be sent to the LinkLift-server; usually this contains the version of the CMS this plugin is used in; default: "". * @return array, associative array of plugin-data, see above for more information false if an error occurred. */ function ll_get_current_plugin_info( $cms_info = "" ) { $server_host = LL_SERVER_HOST; $linklift_website_key = urlencode(LL_WEBSITE_KEY); $linklift_secret = urlencode(LL_PLUGIN_SECRET); $linklift_method = urlencode("current_plugin_version"); $cms_info_encoded = urlencode($cms_info); $request = "GET /external/external_info/" . "?website_key" . "=" . $linklift_website_key . "&linklift_secret" . "=" . $linklift_secret . "&method" . "=" . $linklift_method . "&plugin_language" . "=" . urlencode(LL_PLUGIN_LANGUAGE) . "&plugin_version" . "=" . urlencode(LL_PLUGIN_VERSION) . "&plugin_date" . "=" . urlencode(LL_PLUGIN_DATE) . "&cms_info" . "=" . $cms_info_encoded . " " . "HTTP/1.0\n" . "Host: " . $server_host . "\n" . "Connection: Close\n" . "\n" . ""; $plugin_info_raw = LinkLiftPlugin::get_page_content( $server_host, $request ); if (empty($plugin_info_raw)) return false; // splits the received page in header and content $file_parts = preg_split( $pattern = '@\r?\n\r?\n@', $subject = $plugin_info_raw, $limit = 2 ); $body =& $file_parts[1]; // every line of the page's body is expected to contain one information $plugin_info_lines = preg_split( $pattern = '@\r?\n@', $subject = $body ); // every valid information is put into an associative array $plugin_info $plug_info = array(); foreach ($plugin_info_lines as $line) { $line_parts = explode( ":", $line, $limit = 2 ); if (2 === count($line_parts)) $plug_info[ $line_parts[0] ] = $line_parts[1]; } //foreach($line) return $plug_info; } //ll_get_current_plugin_info() /** * Returns a URL that this plugin can be updated with. * * class-method ("static") * * @author akniep (Andreas Rayo Kniep) * @since 2008-02-16 * @return string the URL to call in order to update this plugin */ function ll_get_update_plugin_url() { $linklift_website_key = urlencode(LL_WEBSITE_KEY); $linklift_secret = urlencode(LL_PLUGIN_SECRET); $linklift_method = urlencode("current_plugin_download"); $request = LL_SERVER_URL . "/external/external_info/" . "?website_key" . "=" . $linklift_website_key . "&linklift_secret" . "=" . $linklift_secret . "&method" . "=" . $linklift_method . "&plugin_language" . "=" . urlencode(LL_PLUGIN_LANGUAGE) . "&plugin_version" . "=" . urlencode(LL_PLUGIN_VERSION) . ""; return $request; } //ll_get_update_plugin_url() /** * The method returns the server's very own 404-page including the page's headers as string! * Therefor, a not-existing page is requested from the local server using the same accapt-language as the one delivered to this request. * The method is invoked by return_error(). * class-method ("static") * * @author akniep (Andreas Rayo Kniep) * @since 2007-12-17 * @return string the server's very own 404-page including the page's headers */ function get_404_page() { $server_host = $_SERVER["SERVER_NAME"]; $language = $_SERVER["HTTP_ACCEPT_LANGUAGE"]; // asking for the same language that was delivered to this request if (! empty($language)) $acceptLanguage = "Accept-Language: " . $language . "\r\n"; else $acceptLanguage = ""; // using carriage returns since Windows-servers may not understand simple newlines (while Linux-servers do not seem to have problems with carriage returns) $request = "GET /this_file_does_not_exist.php " . "HTTP/1.0\r\n" . "Host: " . $server_host . "\r\n" . $acceptLanguage . "Connection: Close\r\n" . "\r\n" . ""; // possible errors ignored! $page404 = LinkLiftPlugin::get_page_content( $server_host, $request ); return $page404; } //get_404_page() /** * The method returns an error-page to a faulty or malicious request. * For $errorCode 404 the local server's very own 404-page is requested and returned. * The method does not return any value, but set headers and print the generated page's body to standard-out, automatically. * class-method ("static") * * @author akniep (Andreas Rayo Kniep) * @since 2007-12-17 * @param $error_code int The HTTP-Code to be returned and set as page-header; default: 404. * @param $error_message string The main error-message to be returned as the page's body; default: "Illegal Request". * @param $headers_to_set array, associative array of strings containing headers to be set when exiting * @return void */ function return_error( $error_code = 404, $error_message = "Illegal Request", $headers_to_set = array() ) { $error_strings = array ( 400 => "Bad Request" , 401 => "Unauthorized" , 404 => "Not Found" , 405 => "Method Not Allowed" , 406 => "Not Acceptable" , 409 => "Conflict" , 500 => "Internal Server Error" ); if (404 == $error_code) { $page404 = LinkLiftPlugin::get_404_page(); // splits the received 404-page in header and content $file_parts = preg_split( $pattern = '@\r?\n\r?\n@', $subject = $page404, $limit = 2 ); $headers = $file_parts[0]; $body = $file_parts[1]; // setting HTTP-headers individually $headers_array = explode("\n", $headers); foreach ($headers_array as $header) header( $header ); // writing the page's body die( $body ); } //if $error_string = ( (isset($error_strings[$error_code])) ? (" " . $error_strings[$error_code]) : ("") ); header("HTTP/1.x " . $error_code . $error_string ); foreach ($headers_to_set as $header => $value) header( $header . ": " . $value ); die( $error_message ); } //return_error() /** * This plugin is not supposed to be called directly, but to be used as inclusion or part of a surrounding CMS. * Direct requests will be responded to with an error, protecting this plugin from prying eyes. * The method does not return any value, but set headers and print the generated page's body to standard-out, automatically. * class-method ("static") * * @author akniep (Andreas Rayo Kniep) * @since 2007-12-17 * @param $check_this_file boolean Set this flag if the check-routine should also disallow direct request to the file this script is a part of (if you have included the LinkLift-plugin in a bigger PHP-script set this parameter to false, for usage within a CSS you can set this flag to true); default: false. * @return void */ function check_request( $check_this_file = false ) { // direct access to the LinkLift-plugin-file is not wanted! if ( ( (false !== strpos( strtolower($_SERVER["SCRIPT_FILENAME"]) , strtolower("linklift_readplug.php") )) || (false !== strpos( strtolower(getenv("SCRIPT_NAME")) , strtolower("linklift_readplug.php") )) ) && (! LL_SECRET_MODE) ) { LinkLiftPlugin::return_error( $errorCode = 404 ); } //if if ($check_this_file) { // direct access to the LinkLift-plugin-file is not wanted! if ( ( (false !== strpos( strtolower($_SERVER["SCRIPT_FILENAME"]) , strtolower( basename(__FILE__) ) )) || (false !== strpos( strtolower(getenv("SCRIPT_NAME")) , strtolower( basename(__FILE__) ) )) ) && (! LL_SECRET_MODE) ) { LinkLiftPlugin::return_error( $errorCode = 404 ); } //if } //if } //check_request() /** * Setter-method for property "linklift_website_key". * The class'-properties are private in PHP5. * * The method is invoked by the class' constructor. * * @author akniep (Andreas Rayo Kniep) * @since 2008-01-02 * @param $instance_linklift_website_key string The new linklift-website-key for this instance. * @return string The former value of the property "linklift_website_key". */ function setWebsiteKey( $instance_linklift_website_key ) { $current_linklift_website_key = $this->getWebsiteKey(); $this->linklift_website_key = $instance_linklift_website_key; return $current_linklift_website_key; } //setWebsiteKey() /** * Getter-method for property "linklift_website_key". * The class'-properties are private in PHP5. * * Usually, the property is set once by the constructor and remains unchanged afterwards. * * @author akniep (Andreas Rayo Kniep) * @since 2007-12-10 * @return string The current value of the linklift_website_key-property. */ function getWebsiteKey() { return $this->linklift_website_key; } //getWebsiteKey() /** * Setter-method for property "xml_filename". * The class'-properties are private in PHP5. * * The method checks wether a linklift-website-key is defined for this instance * and extends the given filename by adding the current linklift-website-key as postfix. * Thus, one plugin may work with and cache textlink-data belonging to different linklift-website-keys. * * The method is invoked by the class' constructor. * * @author akniep (Andreas Rayo Kniep) * @since 2008-01-02 * @param $instance_xml_filename string The new XML-filename that is used when textlink-data that has been downloaded from the LinkLift-server is cached. * @return string The former value of the property "xml_filename". */ function setXmlFilename( $instance_xml_filename = "" ) { $current_xml_filename = $this->getXmlFilename(); $instance_linklift_website_key = $this->getWebsiteKey(); if (! empty($instance_linklift_website_key)) { $xml_filename_length = LinkLiftPlugin::ll_call_str_function_encoding_dependent("strlen", array($instance_xml_filename)); if ( ( 0 >= $xml_filename_length) || ( false === ($file_format_start = LinkLiftPlugin::ll_call_str_function_encoding_dependent("strrpos", array($instance_xml_filename, ".") )) ) ) { $file_format_start = $xml_filename_length; } //if $instance_xml_filename = LinkLiftPlugin::ll_call_str_function_encoding_dependent("substr", array($instance_xml_filename, 0, $file_format_start)) . ( (0 < $file_format_start) ? ("_") : ("") ) . $instance_linklift_website_key . LinkLiftPlugin::ll_call_str_function_encoding_dependent("substr", array($instance_xml_filename, $file_format_start, $xml_filename_length)) . ""; } //if $this->xml_filename = $instance_xml_filename; // moved here in order to update cache-time after XML-filename-change (remember problems with Serendipity) if (file_exists( $instance_xml_filename )) $this->setXmlCacheTime( filemtime($instance_xml_filename) ); return $current_xml_filename; } //setXmlFilename() /** * Getter-method for property "xml_filename". * The class'-properties are private in PHP5. * * Usually, the property is set once by the constructor and remains unchanged afterwards. * Some CMS-plugins, though, will set the XML-filename later when having access to the CMS'-database. * * @author akniep (Andreas Rayo Kniep) * @since 2008-01-02 * @return string The current value of the xml_filename-property. */ function getXmlFilename() { return $this->xml_filename; } //getXmlFilename() /** * Setter-method for property "links_to_show". * The class'-properties are private in PHP5. * * The method checks wether the given value is an array. If not an empty array is used as new value. * * The method is invoked by the class' constructor. * * @author akniep (Andreas Rayo Kniep) * @since 2008-01-02 * @param $instance_links_to_show array Array of integers, holding the new value of links to be shown by this instance. * @return array The former value of the property "links_to_show". */ function setLinksToShow( $instance_links_to_show = "" ) { $current_instance_links_to_show = $this->getLinksToShow(); $this->links_to_show = ( (is_array($instance_links_to_show)) ? ($instance_links_to_show) : (array()) ); return $current_instance_links_to_show; } //setLinksToShow() /** * Getter-method for property "links_to_show". * The class'-properties are private in PHP5. * * Usually, the property is set once by the constructor and remains unchanged afterwards. * * @author akniep (Andreas Rayo Kniep) * @since 2008-01-02 * @return string The current value of the links_to_show-property. */ function getLinksToShow() { return $this->links_to_show; } //getLinksToShow() /** * Setter-method for property "xml_cache_time". * * @author akniep (Andreas Rayo Kniep) * @since 2007-12-17 * @param $xml_cache_time int The time the cached XML has been updated for the last time; default: NOW / time(). * @return void */ function setXmlCacheTime( $xml_cache_time = -1 ) { if (0 > $xml_cache_time) $xml_cache_time = time(); $this->xml_cache_time = $xml_cache_time; } //setXmlCacheTime() /** * Getter-method for property "xml_cache_time". * Note: in LL_DEBUG_MODE = 3 this method will always return 0 in order to force an update of the XML-cache. * * @author akniep (Andreas Rayo Kniep) * @since 2007-12-17 * @return int The time the cached XML has been updated for the last time. */ function getXmlCacheTime() { if (5 == LL_DEBUG_MODE) return 0; else return $this->xml_cache_time; } //getXmlCacheTime() /** * Setter-method for property "xml_cache". * * @author akniep (Andreas Rayo Kniep) * @since 2007-12-17 * @param $xml_cache string The XML-string to be cached / that is cached. * @param $update_time boolean Set this flag in order to let the method update the xml_cache_time to NOW / time(); default: false. * @return void */ function setXmlCache( $xml_cache, $update_time = false ) { $this->xml_cache = $xml_cache; if ($update_time) $this->setXmlCacheTime(); } //setXmlCache() /** * Getter-method for property "xml_cache". * Note: in LL_DEBUG_MODE = 3 this method will always return 0 in order to force an update of the XML-cache. * * @author akniep (Andreas Rayo Kniep) * @since 2007-12-17 * @return string The currently cached XML. */ function getXmlCache() { return $this->xml_cache; } //getXmlCache() /** * This method outputs an instance's current state by returning the values of its fields and constants. * Use it for debugging-information. * * @author akniep (Andreas Rayo Kniep) * @since 2007-12-17 * @return string, the object's current state as string */ function __toString() { $seperator = " / "; $return_array = array(); $return_array[] = "LinkLift Plugin"; $return_array[] = "Linklift-Website-Key: " . $this->getWebsiteKey(); $return_array[] = "XML-Filename: " . $this->getXmlFilename(); $return_array[] = "Links to show: " . implode(",", $this->getLinksToShow()); $return_array[] = "XML-cache update time: " . $this->getXmlCacheTime() . " (" . date("Y-m-d H:i:s", $this->getXmlCacheTime()). ")"; $return_array[] = "Data Timeout: " . $this->data_timeout; $return_array[] = "Plugin Language: " . $this->plugin_language; $return_array[] = "Plugin Version: " . $this->plugin_version; $return_array[] = "Plugin Date: " . $this->plugin_date; $return_str = implode($seperator, $return_array); return $return_str; } //__toString() /** * The method retrieves textlink-data to your adspace from the LinkLift-server. * The data is received in XML-format and contains information about all textlinks currently booked on your adspace. * The received XML is saved as instance-property xml_cache. * The method is invoked by ll_textlink_code() if the local XML-file is not existent or out-of-date. * * @author akniep (Andreas Rayo Kniep) * @since 2006-09-18 * @return void */ function ll_retrieve_xml_from_ll_server() { $server_host = LL_SERVER_HOST; $linklift_website_key = urlencode($this->getWebsiteKey()); $linklift_secret = urlencode(LL_PLUGIN_SECRET); $request = "GET /external/textlink_data/" . "?website_key" . "=" . $linklift_website_key . "&linklift_secret" . "=" . $linklift_secret . "&plugin_language" . "=" . urlencode($this->plugin_language) . "&plugin_version" . "=" . urlencode($this->plugin_version) . "&plugin_date" . "=" . urlencode($this->plugin_date) . "&plugin_creation_date" . "=" . urlencode($this->plugin_creation_date) . "&http_request_uri" . "=" . ( (isset($_SERVER["REQUEST_URI"]) ) ? (urlencode($_SERVER["REQUEST_URI"]) ) : ("") ) . "&http_user_agent" . "=" . ( (isset($_SERVER["HTTP_USER_AGENT"])) ? (urlencode($_SERVER["HTTP_USER_AGENT"])) : ("") ) . "&linklift_title" . "=" . urlencode("") . "&condition_no_css" . "=" . ( (true) ? ("1") : ("0") ) . "&condition_no_html_tags" . "=" . ( (false) ? ("1") : ("0") ) . " " . "HTTP/1.0\n" . "Host: " . $server_host . "\n" . "Connection: Close\n" . "\n" . ""; // possible errors lead to the xmlCache not being (re-)set $xml = LinkLiftPlugin::get_page_content( $server_host, $request ); // Server returned an answer to a one-time-password-request. if (preg_match( '@<' . LL_ONE_TIME_PASSWORD_ANSWER_TAG . '_' . $linklift_website_key . '>([^<]*)@i' , $xml , $matches )) { $plugin_secret = trim( $matches[1] ); // a plugin-secret could be extracted and is saved to the database. if ( ($plugin_secret) && ($plugin_secret !== LL_PLUGIN_SECRET) ) { LinkLiftPlugin::ll_set_option( LL_OPTION_PLUGIN_SECRET, $plugin_secret ); // there is no need for another request, since, the next visitor should trigger the next try with the correct password. $xml = ""; } //if } //if // saving the received XML to instance-property "xml_cache" if (false !== strpos($xml, "setXmlCache( strstr($xml, "getXmlCache(); if (5 == LL_DEBUG_MODE) echo sprintf( "[LinkLift] Debug (%s): The object's current XML-cache that will be used to parse textlink-data:" , LL_DEBUG_MODE ) . "\n" . $xml; // well-formedness of XML is assumed! $textlink_data_fields = array( "prefix" , "url" , "text" , "postfix" , "rss_prefix" , "rss_url" , "rss_text" , "rss_postfix" ); $plugin_fields = array( "language" , "version" , "pl_date" ); $xml_fields = array_merge($textlink_data_fields, $plugin_fields); $parsed_xml_array = array(); foreach ($xml_fields as $field) { preg_match_all ('!<' . $field . '[^>]*>(.*?)!im', $xml, $parsed_xml_array[$field], PREG_SET_ORDER); } //foreach($field) // ### Extracting plugin-data ################################################# $server_plugin = array(); $plugin_to_save = -1; foreach ($plugin_fields as $field) { foreach ($parsed_xml_array[$field] as $nr => $value) { if ( ("language" == $field) && ($this->plugin_language == $value[1]) ) { $plugin_to_save = $nr; } //if; $server_plugin[$nr][$field] = $value[1]; } //foreach($value) } //foreach($field) if (! empty($server_plugin[$plugin_to_save])) usleep(0); // void / doing nothing. No saving of plugin-properties for this plugin-language. // ### Extracting textlink-data ############################################### $textlink_data = array(); foreach ($textlink_data_fields as $field) { foreach ($parsed_xml_array[$field] as $nr => $value) { $parsed_value = $value[1]; // LinkLift may use CData-elements in its XML-feeds that can be recognised by XML-parsers. $parsed_value = str_replace(array(""), "", $parsed_value); $textlink_data[$nr][$field] = $parsed_value; } //foreach($value) } //foreach($field) return $textlink_data; } //ll_retrieve_textlink_data_from_xml() /** * The method retrieves textlink-data to your adspace from the local XML-file (i.e. the file-system). * The data is read in XML-format and contains information about all textlinks currently booked on your adspace. * Usually, the local XML-file gets updated after a certain period of time by calling ll_retrieve_xml_from_ll_server(). * The read XML is saved as instance-property xml_cache. * The method is invoked by ll_textlink_code() if there is a local XML-file and it is not out-of-date. * * @author akniep (Andreas Rayo Kniep) * @since 2006-09-18 * @return void */ function ll_retrieve_xml_from_file_system() { $xml = ""; $xml_filename = $this->getXmlFilename(); if ( (file_exists($xml_filename)) && (is_readable($xml_filename)) && ($xmlfile = fopen($xml_filename, "r")) ) { $xml = fread($xmlfile, filesize($xml_filename)); fclose($xmlfile); $this->setXmlCache( $xml, $update_time = false ); } //if } //ll_retrieve_xml_from_file_system() /** * The method writes textlink-data to your adspace into the local XML-file (i.e. the file-system). * The data is received in XML-format and contains information about all textlinks currently booked on your adspace. * Usually, the delivered textlink-data has just been received, i.e. downloaded, from the LinkLift-server using ll_retrieve_xml_from_ll_server(). * The method is invoked by ll_textlink_code() after calling ll_retrieve_xml_from_ll_server() and if the received data exceeds a certain length (of bytes). * * @author akniep (Andreas Rayo Kniep) * @since 2006-09-18 * @param $xml string The textlink-data in XML-format that, usually, has just been received from the LinkLift-server, may be left empty in order to save the instance's xml_cache. * @return void */ function ll_write_xml_to_file_system( $xml = "" ) { if (empty($xml)) $xml = $this->getXmlCache(); $xml_filename = $this->getXmlFilename(); if ($xmlfile = fopen($xml_filename, "w")) { fwrite($xmlfile, $xml); fclose($xmlfile); } //if } //ll_write_xml_to_file_system() /** * The method generates a textlink-array like the one created by ll_retrieve_textlink_data_from_xml() out of LinkLift's XML-feed. * If no debug-mode is active the generated array will be empty, otherwise, contain a textlink depending on the current debug-mode. * The method is invoked by ll_textlink_code(). * * @author akniep (Andreas Rayo Kniep) * @since 2007-12-17 * @return array associative array containing textlinks that can be displayed within the generated HTML-code */ function get_debug_links() { $debug_links = array(); if ( LL_DEBUG_MODE ) { if (function_exists( "md5" )) $md5_answer = md5( LL_PLUGIN_SECRET ); else $md5_answer = ""; // displaying an "answer" to the DEBUG_MODE-request if (1 != LL_DEBUG_MODE) $debug_links[] = array("text" => "Debug-Mode {" . LL_DEBUG_MODE . "} - (" . $md5_answer . ")", "url" => "http://www.linklift.com/", "prefix" => "[-- ", "postfix" => " --]"); // see above for the purposes of the following debug-modes switch( LL_DEBUG_MODE ) { case (1): $debug_links[] = array("text" => "30 Chars TextLink text - äßćłą", "url" => "http://www.linklift.com/", "prefix" => "", "postfix" => ""); break; case (2): $debug_links[] = array("text" => "", "url" => "http://www.linklift.com/somefolder/someSecondFolder/some-third-folder/someFile.php?somequery=1&someQuery=value&some-query=true&", "prefix" => "", "postfix" => ""); break; case (3): $debug_links[] = array("text" => "", "url" => "http://www.linklift.com/", "prefix" => "", "postfix" => ""); break; case (4): $external_array = array( "LL_WEBSITE_KEY" , "LL_PLUGIN_LANGUAGE" , "LL_PLUGIN_VERSION" , "LL_PLUGIN_DATE" , "LL_PLUGIN_CREATION_DATE" , "LL_PLUGIN_SECRET" , "LL_DATA_TIMEOUT" ); $external_array = array_map( create_function('$element', 'return $element . "=" . constant($element);'), $external_array ); $external_data = implode( " / ", $external_array ); $debug_links[] = array("text" => "", "url" => "http://www.linklift.com/", "prefix" => "", "postfix" => ""); break; case (10): $debug_links[] = array("text" => "", "url" => "http://www.linklift.com/", "prefix" => "", "postfix" => ""); break; case (99): $debug_links[] = array("text" => "1,2,3,4,5,10,99", "url" => "http://www.linklift.com/", "prefix" => "", "postfix" => ""); break; } //switch(LL_DEBUG_MODE) } //if return $debug_links; } //get_debug_links() /** * This method is the actual "main"-method of the LinkLift-plugin. * The method * - retrieves textlink-data to your adspace from the LinkLift-server and stores it in a local XML-file (for reuse) - calling ll_retrieve_xml_from_ll_server(); * or retrieves the textlink-data from that local XML-file in order to minimize outbound-traffic - calling ll_retrieve_xml_from_file_systems(). * - parses the downloaded or read textlink-data in XML-format into an utilisable array of textlinks - calling ll_retrieve_textlink_data_from_xml(). * - generates and outputs plain HTML-links using some CSS-styles in order to obtain the looks you chose on the LinkLift-website; * intentionally, the generated code tries to be as ordinary as possible in order to integrate best with your own HTML-code. * * No value is returned since the generated HTML-code is directly outputted to your website (except for delivering $return = true). * The method is invoked either at the end of the plugin (using PHP-plugin) or at the position of your choice within your website or blog (using one of the CMS-/Blog-software-plugins). * * @author akniep (Andreas Rayo Kniep) * @since 2006-09-18, 2006-12-03, 2007-10-26 * @param $return boolean Indicating whether the generated HTML-code should be returned ($return == true), or written to standard-out (echo); default: false. * @return the generated HTML-code containing your current textlinks, or void if ($return == false), then, HTML will be written to standard-out. */ function ll_textlink_code( $return = false ) { $linklift_website_key = $this->getWebsiteKey(); $xml_filename = $this->xml_filename; // checking local XML file if (! file_exists($xml_filename)) { if ($createTest = fopen($xml_filename, "a")) { fclose($createTest); } else { if (LL_DEBUG_MODE) $die_message = "[LinkLift] Error: ".$xml_filename." does not exist and can not be created. Please create a writeable file called ".$xml_filename."."; else $die_message = ""; if ($return) return $die_message; else echo $die_message; return; } //if-else } //if if ( (! is_file($xml_filename)) || (! is_writable($xml_filename)) || (! is_readable($xml_filename)) ) { if (LL_DEBUG_MODE) $die_message = "[LinkLift] Error: ".$xml_filename." is not a writable (and readable) file. Please create a writeable file called ".$xml_filename."."; else $die_message = ""; if ($return) return $die_message; else echo $die_message; return; } //if // retrieving data from LL-server if ( ($this->getXmlCacheTime() < time() - 3600) || (40 > filesize($xml_filename)) ) { $this->ll_retrieve_xml_from_ll_server(); } //if // storing/retrieving data to/from local XML-file if (40 < strlen( $this->getXmlCache() )) $this->ll_write_xml_to_file_system(); else $this->ll_retrieve_xml_from_file_system(); // parsing XML-data $textlink_data = $this->ll_retrieve_textlink_data_from_xml(); if (5 == LL_DEBUG_MODE) { echo sprintf( "[LinkLift] Debug (%s): Parsed textlink-data-array:" , LL_DEBUG_MODE ) . "\n"; print_r($textlink_data); } //if if (! is_array($textlink_data)) return ""; // a possible debug-mode helping to analyse problems or functionality of the plugin $debug_links = $this->get_debug_links(); $textlink_data = array_merge( $debug_links, $textlink_data ); // filtering testlinks, links that should not be shown or are shown elsewhere, and special LinkLift-links foreach ($textlink_data as $key => $link) { // if a certain subset of textlinks has been specified by links_to_show, the current textlink has to be part of it in order to be shown $links_to_show = $this->getLinksToShow(); if ( (! empty($links_to_show)) && (! in_array($key, $links_to_show)) ) { unset($textlink_data[$key]); } //if // filtering testlinks and special LinkLift-links, these are links containing the plugin's secret in their URL ... if ( (0 < strlen(LL_PLUGIN_SECRET)) && (false !== strpos($link["url"], LL_PLUGIN_SECRET)) && (! LL_SECRET_MODE) ) { unset($textlink_data[$key]); } //if } //foreach($link) // if there are no textlinks at this time the plugin will not display anything. if (0 >= count($textlink_data)) return ""; // creating and outputting textlinks // generating HTML-links // ---------------------------------------------------------------------------v // the appearance of the generated HTML-links depends on // - the default values as chosen on LinkLift's own plug-in-generation-panel // - the parameters that have been chosen within the configuration page of your LinkLift-plugin (if possible) // --- CSS-parameters ---------------------------------------- $number_of_links_per_row = 2; $styles_ul = array(); $styles_li = array(); $styles_a = array(); if (1 < $number_of_links_per_row) { $styles_li[] = 'width:' . floor(100 / $number_of_links_per_row -1) . '%;'; $styles_li[] = 'float:left;'; } //if $styles_ul[] = "background-color:;"; $styles_ul[] = "border:0px none #FFFFFF;"; $styles_a[] = "font-size:12px;"; $styles_a[] = "color:;"; // --- style-attributes -------------------------------------- if (function_exists("array_filter")) { $styles_ul = array_filter( $styles_ul, create_function('$style', 'return (strpos($style,":;") === false);') ); $styles_li = array_filter( $styles_li, create_function('$style', 'return (strpos($style,":;") === false);') ); $styles_a = array_filter( $styles_a , create_function('$style', 'return (strpos($style,":;") === false);') ); } //if // --- style-attributes -------------------------------------- $css_ul = ' style="' . implode(' ', $styles_ul) . '"'; $css_li = ' style="' . implode(' ', $styles_li) . '"'; $css_a = ' style="' . implode(' ', $styles_a ) . '"'; // the following condition will evaluate to true // if you have chosen not to use CSS-styles within the generated HTML-links if (true) { $css_ul = ''; $css_a = ''; if (1 >= $number_of_links_per_row) $css_li = ''; } //if-else // --- HTML-Tags --------------------------------------------- $tag_ul1 = ''; $tag_ul2 = ''; $tag_li1 = ''; $tag_li2 = ''; // the following condition will evaluate to true // if you have chosen not to use the HTML-tags

and
• within the generated HTML-links if (false) { $tag_ul1 = ''; $tag_ul2 = ''; $tag_li1 = ''; if (1 >= $number_of_links_per_row) $tag_li2 = '
  '; else $tag_li2 = ''; } //if-else // --- HTML -------------------------------------------------- $line_break = "\r\n"; $indentation = "\t\t"; $output = $line_break . $indentation . $tag_ul1 . $line_break; $link_counter = 0; foreach ($textlink_data as $key => $link) { $output .= $indentation . ( (empty($line_break)) ? ("") : ("\t") ) // no indentation if there are no linebreaks . $tag_li1 . $link["prefix"] . '' // you may add target="_self" in order to give the link full strength . $link["text"] . '' . $link["postfix"] . $tag_li2 // adding a line-break if a certain number of links should stand together in a row . ( ( (false) && (1 < $number_of_links_per_row) && (0 == ++$link_counter % $number_of_links_per_row) ) ? ("
  ") : ("") ) . $line_break; } //foreach($link) $output .= $indentation . $tag_ul2 . $line_break; // ---------------------------------------------------------------------------^ // usually, the generated HTML-content is written to standard-out // however, you may choose that the method returns the code if ($return) return $output; else echo $output; } //ll_textlink_code() /** * Placeholding method. * class-method ("static") * * @author akniep (Andreas Rayo Kniep) * @since 2008-05-08 * @param $options_table_key string, the key of the value to be retrieved from the Wordpress-options-table (wp_options) * @param $default_value mixed, the default value that should be returned if the given key is undefined in the Wordpress-options-table (wp_options), default: "" (empty string) * @return string, the value to the given key retrieved from the Wordpress-options-table (wp_options), or $default_value if the given key is undefined */ function ll_get_option( $options_table_key, $default_value = "" ) { } //ll_get_option() /** * Placeholding method. * class-method ("static") * * @author akniep (Andreas Rayo Kniep) * @since 2008-05-08 * @param $options_table_key string, the variable-name, the given value can be retrieved again with * @param $new_value mixed, the variable-value to be persisted in the CMS-database * @return void */ function ll_set_option( $options_table_key, $new_value = "" ) { } //ll_set_option() /*wpee * */ } //class(LinkLiftPlugin) } //if (! class_exists(LinkLiftPlugin)) if (is_callable("LinkLiftPlugin", "check_request")) LinkLiftPlugin::check_request($check_this_file = false); if (is_callable(array("LinkLiftPlugin", "execute"))) LinkLiftPlugin::execute( $return = false ); ?>