You are here

Home » API reference » ShrinkTheWeb 6

shrinktheweb.api.inc in ShrinkTheWeb 6

Same filename and directory in other branches
  1. 8 shrinktheweb.api.inc
  2. 7 shrinktheweb.api.inc

File

shrinktheweb.api.inc
View source 
<?php

/**
 * Prerequisites: PHP4 (tested 4.4.1+), PHP5
 * Maintainers: Andreas Pachler, Brandon Elliott
 *
 *	For the latest documentation and best practices: please visit http://www.shrinktheweb.com/content/shrinktheweb-pagepix-documentation.html
 */
define('ACCESS_KEY', variable_get('shrinktheweb_access_key', ''));
define('SECRET_KEY', variable_get('shrinktheweb_secret_key', ''));
define('THUMBNAIL_DIR', file_directory_path() . '/' . variable_get('shrinktheweb_thumbs_folder', '') . '/');
define('THUMBNAIL_URI', file_create_url(THUMBNAIL_DIR) . '/');
define('INSIDE_PAGES', variable_get('shrinktheweb_inside_pages', ''));

// set to true if inside capturing should be allowed
define('CUSTOM_MSG_URL', variable_get('shrinktheweb_custom_msg_url', ''));

// i.e. 'http://yourdomain.com/path/to/your/custom/msgs'
define('CACHE_DAYS', variable_get('shrinktheweb_cache_days', ''));

// how many days should the local copy be valid?
// Enter 0 (zero) to never update screenshots once cached
// Enter -1 to disable caching and always use embedded method instead
define('VER', '2.0.6_drupal6');

// allows us to identify known bugs and version control; DONT touch!
define('QUOTA_IMAGE', 'quota.jpg');
define('BANDWIDTH_IMAGE', 'bandwidth.jpg');
define('NO_RESPONSE_IMAGE', 'no_response.jpg');
define('MAINTENANCE', 'ShrinkTheWeb is temporarily offline for maintenance');
define('DEBUG', variable_get('shrinktheweb_debug', ''));

// MUST be "true" to log debug entries to database
error_reporting(E_ALL ^ E_NOTICE);

/********************************************
 *	!! DO NOT CHANGE BELOW THIS LINE !!		*
 *	...unless you know what you are doing	*
 ********************************************/

/**
 * Gets the thumbnail for the specified website, stores it in the cache, and then returns the HTML for loading the image.
 * !!! SLIGTHLY CHANGED FOR DRUPAL !!!
 */
function shrinktheweb_getThumbnailURL($sUrl, $aOptions = array()) {
  $sImageURL = false;
  $aOptions = shrinktheweb_generateOptions($aOptions);
  $sImageURL = shrinktheweb_getThumbnailAdvanced($sUrl, $aOptions);
  return $sImageURL;
}

/**
 * Delete thumbnail
 */
function shrinktheweb_deleteThumbnail($sUrl, $aOptions = array()) {
  $aOptions = shrinktheweb_generateOptions($aOptions);
  $aArgs = shrinktheweb_generateRequestArgs($aOptions);
  $aArgs['stwurl'] = $sUrl;
  $sFilename = shrinktheweb_generateHash($aArgs) . '.jpg';
  $sFile = THUMBNAIL_DIR . $sFilename;
  if (file_exists($sFile)) {
    @unlink($sFile);
  }
}

/**
 * Delete cached images
 */
function shrinktheweb_deleteAllImages() {
  $rDir = opendir(THUMBNAIL_DIR);
  while (false !== ($sFile = readdir($rDir))) {
    if ($sFile != "." && $sFile != "..") {
      @unlink(THUMBNAIL_DIR . $sFile);
    }
  }
  closedir($rDir);
}

/**
 * Delete error images
 */
function shrinktheweb_deleteErrorImages() {
  $aFilenames = array(
    'quota' => THUMBNAIL_DIR . QUOTA_IMAGE,
    'bandwidth' => THUMBNAIL_DIR . BANDWIDTH_IMAGE,
    'no_response' => THUMBNAIL_DIR . NO_RESPONSE_IMAGE,
  );
  foreach ($aFilenames as $sFile) {
    if (file_exists($sFile)) {
      @unlink($sFile);
    }
  }
}

/**
 * refresh a thumbnail for a url with specified options
 * first delete it and then do a new request and return the HTML for image loading
 * !!! SLIGTHLY CHANGED FOR DRUPAL !!!
 */
function shrinktheweb_refreshThumbnail($sUrl, $aOptions = array()) {
  $aOptions = shrinktheweb_generateOptions($aOptions);
  $aOptions['RefreshOnDemand'] = true;
  shrinktheweb_deleteThumbnail($sUrl, $aOptions);
  $sImageURL = shrinktheweb_getThumbnailHTML($sUrl, $aOptions);
  return $sImageURL;
}

/**********************
 *  PRIVATE FUNCTIONS  *
 **********************/

// getting the thumbnal with advanced api
// !!! SLIGTHLY CHANGED FOR DRUPAL !!!
function shrinktheweb_getThumbnailAdvanced($sUrl, $aOptions) {
  $sImageUrl = shrinktheweb_getThumbnail($sUrl, $aOptions);

  // if WAY OVER the limits (i.e. request is ignored by STW), grab an "Account Problem" image and store it as NO_RESPONSE_IMAGE
  if ($sImageUrl == 'no_response') {
    $sImageUrl = shrinktheweb_getNoResponseImage($sUrl, $aOptions);
  }
  return $sImageUrl;
}

/**
 * Gets the thumbnail for the specified website, stores it in the cache, and then returns the
 * relative path to the cached image.
 */
function shrinktheweb_getThumbnail($sUrl, $aOptions) {

  // create cache directory if it doesn't exist
  shrinktheweb_createCacheDirectory();
  $aArgs = shrinktheweb_generateRequestArgs($aOptions);

  // Try to grab the thumbnail
  $iCacheDays = CACHE_DAYS + 0;
  if ($iCacheDays >= 0 && $aOptions['Embedded'] != 1) {
    $aArgs['stwurl'] = $sUrl;
    $sImageUrl = shrinktheweb_getCachedThumbnail($aArgs);
  }
  else {

    // Get raw image data
    unset($aArgs['stwu']);

    // ONLY on "Advanced" method requests!! (not allowed on embedded)
    $aArgs['stwembed'] = 1;
    $aArgs['stwurl'] = $sUrl;
    $sImageUrl = urldecode("http://images.shrinktheweb.com/xino.php?" . http_build_query($aArgs, '', '&'));
  }
  return $sImageUrl;
}

/**
 * generate options
 */

// !!! SLIGTHLY CHANGED FOR DRUPAL !!!
function shrinktheweb_generateOptions($aOptions) {

  // check if there are options set, otherwise set it to default or false
  $aOptions['Size'] = isset($aOptions['Size']) ? $aOptions['Size'] : variable_get('shrinktheweb_thumb_size', '');
  $aOptions['SizeCustom'] = isset($aOptions['SizeCustom']) ? $aOptions['SizeCustom'] : variable_get('shrinktheweb_thumb_size_custom', '');
  $aOptions['FullSizeCapture'] = isset($aOptions['FullSizeCapture']) ? $aOptions['FullSizeCapture'] : variable_get('shrinktheweb_full_size', '');
  $aOptions['MaxHeight'] = isset($aOptions['MaxHeight']) ? $aOptions['MaxHeight'] : variable_get('shrinktheweb_max_height', '');
  $aOptions['NativeResolution'] = isset($aOptions['NativeResolution']) ? $aOptions['NativeResolution'] : variable_get('shrinktheweb_native_res', '');
  $aOptions['WidescreenY'] = isset($aOptions['WidescreenY']) ? $aOptions['WidescreenY'] : variable_get('shrinktheweb_widescreen_y', '');
  $aOptions['RefreshOnDemand'] = isset($aOptions['RefreshOnDemand']) ? $aOptions['RefreshOnDemand'] : false;
  $aOptions['Delay'] = isset($aOptions['Delay']) ? $aOptions['Delay'] : variable_get('shrinktheweb_delay', '');
  $aOptions['Quality'] = isset($aOptions['Quality']) ? $aOptions['Quality'] : variable_get('shrinktheweb_quality', '');
  return $aOptions;
}

/**
 * generate the request arguments
 */
function shrinktheweb_generateRequestArgs($aOptions) {
  $aArgs['stwaccesskeyid'] = ACCESS_KEY;
  $aArgs['stwu'] = SECRET_KEY;
  $aArgs['stwver'] = VER;

  // allowing internal links?
  if (INSIDE_PAGES) {
    $aArgs['stwinside'] = 1;
  }

  // If SizeCustom is specified and widescreen capturing is not activated,
  // then use that size rather than the size stored in the settings
  if (!$aOptions['FullSizeCapture'] && !$aOptions['WidescreenY']) {

    // Do we have a custom size?
    if ($aOptions['SizeCustom']) {
      $aArgs['stwxmax'] = $aOptions['SizeCustom'];
    }
    else {
      $aArgs['stwsize'] = $aOptions['Size'];
    }
  }

  // Use fullsize capturing?
  if ($aOptions['FullSizeCapture']) {
    $aArgs['stwfull'] = 1;
    if ($aOptions['SizeCustom']) {
      $aArgs['stwxmax'] = $aOptions['SizeCustom'];
    }
    else {
      $aArgs['stwxmax'] = 120;
    }
    if ($aOptions['MaxHeight']) {
      $aArgs['stwymax'] = $aOptions['MaxHeight'];
    }
  }

  // Change native resolution?
  if ($aOptions['NativeResolution']) {
    $aArgs['stwnrx'] = $aOptions['NativeResolution'];
    if ($aOptions['WidescreenY']) {
      $aArgs['stwnry'] = $aOptions['WidescreenY'];
      if ($aOptions['SizeCustom']) {
        $aArgs['stwxmax'] = $aOptions['SizeCustom'];
      }
      else {
        $aArgs['stwxmax'] = 120;
      }
    }
  }

  // Wait after page load in seconds
  if ($aOptions['Delay']) {
    $aArgs['stwdelay'] = intval($aOptions['Delay']) <= 45 ? intval($aOptions['Delay']) : 45;
  }

  // Use Refresh On-Demand?
  if ($aOptions['RefreshOnDemand']) {
    $aArgs['stwredo'] = 1;
  }

  // Use another image quality in percent
  if ($aOptions['Quality']) {
    $aArgs['stwq'] = intval($aOptions['Quality']);
  }

  // Use custom messages?
  if (CUSTOM_MSG_URL) {
    $aArgs['stwrpath'] = CUSTOM_MSG_URL;
  }
  return $aArgs;
}

/**
 * Get a thumbnail, caching it first if possible
 */
function shrinktheweb_getCachedThumbnail($aArgs = null) {
  $aArgs = is_array($aArgs) ? $aArgs : array();

  // Use arguments to work out the target filename
  $sFilename = shrinktheweb_generateHash($aArgs) . '.jpg';
  $sFile = THUMBNAIL_DIR . $sFilename;
  $sReturnName = false;

  // Work out if we need to update the cached thumbnail
  $iForceUpdate = $aArgs['stwredo'] ? true : false;
  if ($iForceUpdate || shrinktheweb_cacheFileExpired($sFile)) {

    // if bandwidth limit has reached return the BANDWIDTH_IMAGE
    if (shrinktheweb_checkLimitReached(THUMBNAIL_DIR . BANDWIDTH_IMAGE)) {
      $sFilename = BANDWIDTH_IMAGE;

      // if quota limit has reached return the QUOTA_IMAGE
    }
    else {
      if (shrinktheweb_checkLimitReached(THUMBNAIL_DIR . QUOTA_IMAGE)) {
        $sFilename = QUOTA_IMAGE;

        // if WAY OVER the limits (i.e. request is ignored by STW) return the NO_RESPONSE_IMAGE
      }
      else {
        if (shrinktheweb_checkLimitReached(THUMBNAIL_DIR . NO_RESPONSE_IMAGE)) {
          $sFilename = NO_RESPONSE_IMAGE;
        }
        else {

          // check if the thumbnail was captured
          $aImage = shrinktheweb_checkWebsiteThumbnailCaptured($aArgs);
          switch ($aImage['status']) {
            case 'save':

              // download the image to local path
              shrinktheweb_downloadRemoteImageToLocalPath($aImage['url'], $sFile);
              break;
            case 'nosave':

              // dont save the image but return the url
              return $aImage['url'];
              break;
            case 'quota_exceed':

              // download the image to local path for locking requests
              $sFilename = QUOTA_IMAGE;
              $sFile = THUMBNAIL_DIR . $sFilename;
              shrinktheweb_downloadRemoteImageToLocalPath($aImage['url'], $sFile);
              break;
            case 'bandwidth_exceed':

              // download the image to local path for locking requests
              $sFilename = BANDWIDTH_IMAGE;
              $sFile = THUMBNAIL_DIR . $sFilename;
              shrinktheweb_downloadRemoteImageToLocalPath($aImage['url'], $sFile);
              break;
            default:

              // otherwise return the status
              return $aImage['status'];
          }
        }
      }
    }
  }
  $sFile = THUMBNAIL_DIR . $sFilename;

  // Check if file exists
  if (file_exists($sFile)) {
    $sReturnName = THUMBNAIL_URI . $sFilename;
  }
  return $sReturnName;
}

/**
 * Adding request to debug log table
 */
function shrinktheweb_addRequestToDB($aSTWArgs, $aResponse, $sHash) {
  $iTimestamp = time();
  $sQueryUpdate = "UPDATE `shrinktheweb_log` SET `timestamp` = '" . $iTimestamp . "', `capturedon` = '" . $aResponse['stw_last_captured'] . "', `invalid` = '" . $aResponse['invalid'] . "',\n    \t\t`stwerrcode` = '" . $aResponse['stw_response_code'] . "', `error` = '" . $aResponse['error'] . "', `errcode` = '" . $aResponse['stw_response_status'] . "' WHERE `hash` = '" . $sHash . "'";
  $sQueryInsert = "INSERT INTO `shrinktheweb_log` SET `domain` = '" . $aSTWArgs['stwurl'] . "', `timestamp` = '" . $iTimestamp . "', `capturedon` = '" . $aResponse['stw_last_captured'] . "',\n    \t\t`quality` = '" . $aSTWArgs['stwqual'] . "', `full` = '" . $aSTWArgs['stwfull'] . "', `xmax` = '" . $aSTWArgs['stwxmax'] . "', `ymax` = '" . $aSTWArgs['stwymax'] . "',\n    \t\t`nrx` = '" . $aSTWArgs['stwnrx'] . "', `nry` = '" . $aSTWArgs['stwnry'] . "', `invalid` = '" . $aResponse['invalid'] . "', `stwerrcode` = '" . $aResponse['stw_response_code'] . "',\n    \t\t`error` = '" . $aResponse['error'] . "', `errcode` = '" . $aResponse['stw_response_status'] . "', `hash` = '" . $sHash . "'";

  // check if there is an entry existing with this hash
  db_query($sQueryUpdate);
  if (db_affected_rows() == 0) {

    // doesn't exist
    db_query($sQueryInsert);
  }
}

/**
 * Method that checks if the thumbnail for the specified website exists
 */
function shrinktheweb_checkWebsiteThumbnailCaptured($aArgs) {
  $sRequestUrl = 'http://images.shrinktheweb.com/xino.php';
  $sRemoteData = shrinktheweb_fileGetContent($sRequestUrl, $aArgs);

  // check if we get no response or the maintenance string
  if ($sRemoteData == '' || $sRemoteData == 'offline') {
    $aImage = array(
      'status' => 'no_response',
    );
    if ($sRemoteData != '') {
      $aImage['message'] = MAINTENANCE;
    }
  }
  else {
    $aResponse = shrinktheweb_getXMLResponse($sRemoteData);

    // thumbnail is existing, download it
    if ($aResponse['exists'] && $aResponse['thumbnail'] != '') {
      $aImage = array(
        'status' => 'save',
        'url' => $aResponse['thumbnail'],
      );

      // bandwidth limit has reached, grab embedded image and store it as BANDWIDTH_IMAGE
    }
    else {
      if ($aResponse['stw_bandwidth_remaining'] == 0 && !$aResponse['locked'] && !$aResponse['invalid'] && !$aResponse['exists'] && !$aResponse['problem']) {
        $aImage = array(
          'status' => 'bandwidth_exceed',
          'url' => $aResponse['thumbnail'],
        );

        // quota limit has reached, grab embedded image and store it as QUOTA_IMAGE
      }
      else {
        if ($aResponse['stw_quota_remaining'] == 0 && !$aResponse['locked'] && !$aResponse['invalid'] && !$aResponse['exists'] && !$aResponse['problem']) {
          $aImage = array(
            'status' => 'quota_exceed',
            'url' => $aResponse['thumbnail'],
          );

          // an error has occured, return the url but dont save the image
        }
        else {
          if (!$aResponse['exists'] && $aResponse['thumbnail'] != '') {
            $aImage = array(
              'status' => 'nosave',
              'url' => $aResponse['thumbnail'],
            );

            // otherwise return error because we dont know the situation
          }
          else {
            $aImage = array(
              'status' => 'error',
            );
          }
        }
      }
    }

    // add the request to the database if debug is enabled
    if (DEBUG) {
      shrinktheweb_addRequestToDB($aArgs, $aResponse, shrinktheweb_generateHash($aArgs));
    }
  }
  return $aImage;
}

/**
 * Method to get image at the specified remote Url and attempt to save it to the specifed local path
 */
function shrinktheweb_downloadRemoteImageToLocalPath($sRemoteUrl, $sFile) {
  $sRemoteData = shrinktheweb_fileGetContent($sRemoteUrl, array());

  // Only save data if we managed to get the file content
  if ($sRemoteData) {
    $rFile = fopen($sFile, "w+");
    fputs($rFile, $sRemoteData);
    fclose($rFile);
  }
  else {

    // Try to delete file if download failed
    if (file_exists($sFile)) {
      @unlink($sFile);
    }
    return false;
  }
  return true;
}

/**
 * Gets the account problem image and returns the relative path to the cached image
 */
function shrinktheweb_getNoResponseImage($sUrl, $aOptions) {

  // create cache directory if it doesn't exist
  shrinktheweb_createCacheDirectory();
  $aOptions = shrinktheweb_generateOptions($aOptions);
  $aArgs['stwaccesskeyid'] = 'accountproblem';
  if ($aOptions['SizeCustom']) {
    $aArgs['stwxmax'] = $aOptions['SizeCustom'];
  }
  else {
    $aArgs['stwsize'] = $aOptions['Size'];
  }
  $sRequestUrl = 'http://images.shrinktheweb.com/xino.php';
  $sRemoteData = shrinktheweb_fileGetContent($sRequestUrl, $aArgs);
  if ($sRemoteData != '') {
    $aResponse = shrinktheweb_getXMLResponse($sRemoteData);
    if (!$aResponse['exists'] && $aResponse['thumbnail'] != '') {
      $sImageUrl = $aResponse['thumbnail'];
      $sFilename = NO_RESPONSE_IMAGE;
      $sFile = THUMBNAIL_DIR . $sFilename;
      $isDownloaded = shrinktheweb_downloadRemoteImageToLocalPath($sImageUrl, $sFile);
      if ($isDownloaded == true) {
        return THUMBNAIL_URI . $sFilename;
      }
    }
  }
  return false;
}

/**
 * Check if the limit reached image is existing, if so return true
 * return false if there is no image existing or the limit reached file is
 * older then 6 hours
 */
function shrinktheweb_checkLimitReached($sFile) {

  // file is not existing
  if (!file_exists($sFile)) {
    return false;
  }

  // is file older then 6 hours?
  $iCutoff = time() - 3600 * 6;
  if (filemtime($sFile) <= $iCutoff) {
    @unlink($sFile);
    return false;
  }

  // file is existing and not expired!
  return true;
}

/**
 * Create cache directory if it doesnt exist
 */
function shrinktheweb_createCacheDirectory() {

  // Create cache directory if it doesnt exist
  if (!file_exists(THUMBNAIL_DIR)) {
    @mkdir(THUMBNAIL_DIR, 0777, true);
  }
  else {

    // Try to make the directory writable
    @chmod(THUMBNAIL_DIR, 0777);
  }
}

/**
 * Generate the hash for the thumbnail, this is used as filename also
 */
function shrinktheweb_generateHash($aArgs) {
  $sPrehash = $aArgs['stwfull'] ? 'a' : 'c';
  $sPrehash .= $aArgs['stwxmax'] . 'x' . $aArgs['stwymax'];
  if ($aArgs['stwnrx']) {
    $sPrehash .= 'b' . $aArgs['stwnrx'] . 'x' . $aArgs['stwnry'];
  }
  $sPrehash .= $aArgs['stwinside'];
  $aReplace = array(
    'http',
    'https',
    'ftp',
    '://',
  );
  $sUrl = str_replace($aReplace, '', $aArgs['stwurl']);
  return md5($sPrehash . $aArgs['stwsize'] . $aArgs['stwq'] . $sUrl);
}

/**
 * store the XML response in an array and generate status bits
 */
function shrinktheweb_getXMLResponse($sResponse) {
  if (extension_loaded('simplexml')) {

    // If simplexml is available, we can do more stuff!
    $oDOM = new DOMDocument();
    $oDOM
      ->loadXML($sResponse);
    $sXML = simplexml_import_dom($oDOM);
    $sXMLLayout = 'http://www.shrinktheweb.com/doc/stwresponse.xsd';

    // Pull response codes from XML feed
    $aResponse['thumbnail'] = $sXML
      ->children($sXMLLayout)->Response->ThumbnailResult->Thumbnail[0];
    $aResponse['stw_action'] = $sXML
      ->children($sXMLLayout)->Response->ThumbnailResult->Thumbnail[1];
    $aResponse['stw_response_status'] = $sXML
      ->children($sXMLLayout)->Response->ResponseStatus->StatusCode;

    // HTTP Response Code
    $aResponse['stw_response_code'] = $sXML
      ->children($sXMLLayout)->Response->ResponseCode->StatusCode;

    // STW Error Response
    $aResponse['stw_last_captured'] = $sXML
      ->children($sXMLLayout)->Response->ResponseTimestamp->StatusCode;

    // Last Captured
    $aResponse['stw_quota_remaining'] = $sXML
      ->children($sXMLLayout)->Response->Quota_Remaining->StatusCode;

    // New Reqs left for today
    $aResponse['stw_bandwidth_remaining'] = $sXML
      ->children($sXMLLayout)->Response->Bandwidth_Remaining->StatusCode;

    // New Reqs left for today
    $aResponse['stw_category_code'] = $sXML
      ->children($sXMLLayout)->Response->CategoryCode->StatusCode;

    // Not yet implemented
  }
  else {

    // LEGACY SUPPPORT
    $aResponse['stw_response_status'] = shrinktheweb_getLegacyResponse('ResponseStatus', $sRemoteData);
    $aResponse['stw_response_code'] = shrinktheweb_getLegacyResponse('ResponseCode', $sRemoteData);

    // check remaining quota
    $aResponse['stw_quota_remaining'] = shrinktheweb_getLegacyResponse('Quota_Remaining', $sRemoteData);

    // check remaining bandwidth
    $aResponse['stw_bandwidth_remaining'] = shrinktheweb_getLegacyResponse('Bandwidth_Remaining', $sRemoteData);

    // get thumbnail and status
    $aThumbnail = shrinktheweb_getThumbnailStatus($sRemoteData);
    $aResponse = array_merge($aResponse, $aThumbnail);
  }
  if ($aResponse['stw_action'] == 'delivered') {
    $aResponse['exists'] = true;
  }
  else {
    $aResponse['exists'] = false;
  }
  if ($aResponse['stw_action'] == 'fix_and_retry') {
    $aResponse['problem'] = true;
  }
  else {
    $aResponse['problem'] = false;
  }
  if ($aResponse['stw_action'] == 'noretry') {
    $aResponse['error'] = true;
  }
  else {
    $aResponse['error'] = false;
  }

  // if we use the advanced api for free account we get an invalid request
  if ($aResponse['stw_response_code'] == 'INVALID_REQUEST') {
    $aResponse['invalid'] = true;
  }
  else {
    $aResponse['invalid'] = false;
  }

  // if our domain or IP is not listed in the account's "Allowed Referrers" AND "Lock to Account" is enabled, then we get this error
  if ($aResponse['stw_response_code'] == 'LOCK_TO_ACCOUNT') {
    $aResponse['locked'] = true;
  }
  else {
    $aResponse['locked'] = false;
  }
  return $aResponse;
}
function shrinktheweb_getLegacyResponse($sSearch, $s) {
  $sRegex = '/<[^:]*:' . $sSearch . '[^>]*>[^<]*<[^:]*:StatusCode[^>]*>([^<]*)<\\//';
  if (preg_match($sRegex, $s, $sMatches)) {
    return $sMatches[1];
  }
  return false;
}
function shrinktheweb_getThumbnailStatus($s) {
  $sRegex = '/<[^:]*:ThumbnailResult?[^>]*>[^<]*<[^:]*:Thumbnail\\s*(?:Exists=\\"((?:true)|(?:false))\\")+[^>]*>([^<]*)<\\//';
  if (preg_match($sRegex, $s, $sMatches)) {
    return array(
      'stw_action' => $sMatches[1],
      'thumbnail' => $sMatches[2],
    );
  }
  return false;
}

/**
 * Determine if specified file has expired from the cache
 */
function shrinktheweb_cacheFileExpired($sFile) {

  // Use setting to check age of files.
  $iCacheDays = CACHE_DAYS + 0;

  // dont update image once it is cached
  if ($iCacheDays == 0 && file_exists($sFile)) {
    return false;

    // check age of file and if file exists return false, otherwise recache the file
  }
  else {
    $iCutoff = time() - 3600 * 24 * $iCacheDays;
    return !file_exists($sFile) || filemtime($sFile) <= $iCutoff;
  }
}

/**
 * Safe method to get the value from an array using the specified key
 */
function shrinktheweb_getArrayValue($aArray, $sKey, $isReturnSpace = false) {
  if ($aArray && isset($aArray[$sKey])) {
    return $aArray[$sKey];
  }

  // If returnSpace is true, then return a space rather than nothing at all
  if ($isReturnSpace) {
    return '&nbsp;';
  }
  else {
    return false;
  }
}

/**
 * Gets file content by URL
 */
function shrinktheweb_fileGetContent($sFileUrl, $aParams = array()) {
  $sParams = '?';
  foreach ($aParams as $sKey => $sValue) {
    $sParams .= $sKey . '=' . $sValue . '&';
  }
  $sParams = substr($sParams, 0, -1);
  $sResult = '';
  if (function_exists('curl_init')) {
    $rConnect = curl_init();
    curl_setopt($rConnect, CURLOPT_URL, $sFileUrl . $sParams);
    curl_setopt($rConnect, CURLOPT_RETURNTRANSFER, 1);
    curl_setopt($rConnect, CURLOPT_FOLLOWLOCATION, 1);
    curl_setopt($rConnect, CURLOPT_HEADER, 0);

    // must be 0 or else headers will break SimpleXML parsing
    $sResult = curl_exec($rConnect);
    curl_close($rConnect);
  }
  else {
    $sResult = @file_get_contents($sFileUrl . $sParams);
  }
  return $sResult;
}

/**
 * Get Account Info and return it as array
 */
function shrinktheweb_getAccountInfo() {
  $aArgs['stwaccesskeyid'] = ACCESS_KEY;
  $aArgs['stwu'] = SECRET_KEY;
  $sRequestUrl = 'http://images.shrinktheweb.com/account.php';
  $sRemoteData = shrinktheweb_fileGetContent($sRequestUrl, $aArgs);

  // check if we get no response or the maintenance string
  if ($sRemoteData == '' || $sRemoteData == 'offline') {
    $aImage = array(
      'stw_status' => 'no_response',
    );
    if ($sRemoteData != '') {
      $aImage['message'] = MAINTENANCE;
    }
  }
  else {
    $aResponse = shrinktheweb_getAccXMLResponse($sRemoteData);
  }
  return $aResponse;
}

/**
 * store the Account XML response in an array
 */
function shrinktheweb_getAccXMLResponse($sResponse) {
  if (extension_loaded('simplexml')) {

    // If simplexml is available, we can do more stuff!
    $oDOM = new DOMDocument();
    $oDOM
      ->loadXML($sResponse);
    $sXML = simplexml_import_dom($oDOM);
    $sXMLLayout = 'http://www.shrinktheweb.com/doc/stwacctresponse.xsd';

    // Pull response codes from XML feed
    $aResponse['stw_response_status'] = $sXML
      ->children($sXMLLayout)->Response->Status->StatusCode;

    // Response Code
    $aResponse['stw_account_level'] = $sXML
      ->children($sXMLLayout)->Response->Account_Level->StatusCode;

    // Account level
    // check for enabled upgrades
    $aResponse['stw_inside_pages'] = $sXML
      ->children($sXMLLayout)->Response->Inside_Pages->StatusCode;

    // Inside Pages
    $aResponse['stw_custom_size'] = $sXML
      ->children($sXMLLayout)->Response->Custom_Size->StatusCode;

    // Custom Size
    $aResponse['stw_full_length'] = $sXML
      ->children($sXMLLayout)->Response->Full_Length->StatusCode;

    // Full Length
    $aResponse['stw_refresh_ondemand'] = $sXML
      ->children($sXMLLayout)->Response->Refresh_OnDemand->StatusCode;

    // Refresh OnDemand
    $aResponse['stw_custom_delay'] = $sXML
      ->children($sXMLLayout)->Response->Custom_Delay->StatusCode;

    // Custom Delay
    $aResponse['stw_custom_quality'] = $sXML
      ->children($sXMLLayout)->Response->Custom_Quality->StatusCode;

    // Custom Quality
    $aResponse['stw_custom_resolution'] = $sXML
      ->children($sXMLLayout)->Response->Custom_Resolution->StatusCode;

    // Custom Resolution
    $aResponse['stw_custom_messages'] = $sXML
      ->children($sXMLLayout)->Response->Custom_Messages->StatusCode;

    // Custom Messages
  }
  else {

    // LEGACY SUPPPORT
    $aResponse['stw_response_status'] = shrinktheweb_getLegacyResponse('Status', $sRemoteData);
    $aResponse['stw_account_level'] = shrinktheweb_getLegacyResponse('Account_Level', $sRemoteData);

    // Account level
    // check for enabled upgrades
    $aResponse['stw_inside_pages'] = shrinktheweb_getLegacyResponse('Inside_Pages', $sRemoteData);

    // Inside Pages
    $aResponse['stw_custom_size'] = shrinktheweb_getLegacyResponse('Custom_Size', $sRemoteData);

    // Custom Size
    $aResponse['stw_full_length'] = shrinktheweb_getLegacyResponse('Full_Length', $sRemoteData);

    // Full Length
    $aResponse['stw_refresh_ondemand'] = shrinktheweb_getLegacyResponse('Refresh_OnDemand', $sRemoteData);

    // Refresh OnDemand
    $aResponse['stw_custom_delay'] = shrinktheweb_getLegacyResponse('Custom_Delay', $sRemoteData);

    // Custom Delay
    $aResponse['stw_custom_quality'] = shrinktheweb_getLegacyResponse('Custom_Quality', $sRemoteData);

    // Custom Quality
    $aResponse['stw_custom_resolution'] = shrinktheweb_getLegacyResponse('Custom_Resolution', $sRemoteData);

    // Custom Resolution
    $aResponse['stw_custom_messages'] = shrinktheweb_getLegacyResponse('Custom_Messages', $sRemoteData);

    // Custom Messages
  }
  return $aResponse;
}

Functions

Namesort descending Description
shrinktheweb_addRequestToDB Adding request to debug log table
shrinktheweb_cacheFileExpired Determine if specified file has expired from the cache
shrinktheweb_checkLimitReached Check if the limit reached image is existing, if so return true return false if there is no image existing or the limit reached file is older then 6 hours
shrinktheweb_checkWebsiteThumbnailCaptured Method that checks if the thumbnail for the specified website exists
shrinktheweb_createCacheDirectory Create cache directory if it doesnt exist
shrinktheweb_deleteAllImages Delete cached images
shrinktheweb_deleteErrorImages Delete error images
shrinktheweb_deleteThumbnail Delete thumbnail
shrinktheweb_downloadRemoteImageToLocalPath Method to get image at the specified remote Url and attempt to save it to the specifed local path
shrinktheweb_fileGetContent Gets file content by URL
shrinktheweb_generateHash Generate the hash for the thumbnail, this is used as filename also
shrinktheweb_generateOptions
shrinktheweb_generateRequestArgs generate the request arguments
shrinktheweb_getAccountInfo Get Account Info and return it as array
shrinktheweb_getAccXMLResponse store the Account XML response in an array
shrinktheweb_getArrayValue Safe method to get the value from an array using the specified key
shrinktheweb_getCachedThumbnail Get a thumbnail, caching it first if possible
shrinktheweb_getLegacyResponse
shrinktheweb_getNoResponseImage Gets the account problem image and returns the relative path to the cached image
shrinktheweb_getThumbnail Gets the thumbnail for the specified website, stores it in the cache, and then returns the relative path to the cached image.
shrinktheweb_getThumbnailAdvanced
shrinktheweb_getThumbnailStatus
shrinktheweb_getThumbnailURL Gets the thumbnail for the specified website, stores it in the cache, and then returns the HTML for loading the image. !!! SLIGTHLY CHANGED FOR DRUPAL !!!
shrinktheweb_getXMLResponse store the XML response in an array and generate status bits
shrinktheweb_refreshThumbnail refresh a thumbnail for a url with specified options first delete it and then do a new request and return the HTML for image loading !!! SLIGTHLY CHANGED FOR DRUPAL !!!

Constants

Namesort descending Description
ACCESS_KEY Prerequisites: PHP4 (tested 4.4.1+), PHP5 * Maintainers: Andreas Pachler, Brandon Elliott * * For the latest documentation and best practices: please visit http://www.shrinktheweb.com/content/shrinktheweb-pagepix-documentation.html
BANDWIDTH_IMAGE
CACHE_DAYS
CUSTOM_MSG_URL
DEBUG
INSIDE_PAGES
MAINTENANCE
NO_RESPONSE_IMAGE
QUOTA_IMAGE
SECRET_KEY
THUMBNAIL_DIR
THUMBNAIL_URI
VER