phpDocumentor deviantartfeed
[ class tree: deviantartfeed ] [ index: deviantartfeed ] [ all elements ]
deviantartfeed
Packages:
deviantartfeed

Source for file deviantart.php

Documentation is available at deviantart.php

  1. <?php
  2.  
  3. /**
  4.  * Scrapes a recent deviations feed together from deviantart.
  5.  *
  6.  * Uses a json formatted string from deviantart which works currently, however
  7.  * any changes will most likley break this. Hopefully only the xsl would need to
  8.  * be updated in such an event.
  9.  *
  10.  * GENERAL DISCLAIMER
  11.  *
  12.  * I am not personally affiliated with DeviantART in any way. Use of the
  13.  * DeviantART website by its Terms Of Service. I am not responsible for the way
  14.  * you use this script. The use of this script to scrape your DeviantART user
  15.  * gallery may be in breach of your agreement with DeviantART.
  16.  *
  17.  * LICENSE
  18.  *
  19.  * This program is free software: you can redistribute it and/or modify it under
  20.  * the terms of the GNU General Public License as published by the Free Software
  21.  * Foundation, either version 3 of the License, or (at your option) any later
  22.  * version.
  23.  *
  24.  * This program is distributed in the hope that it will be useful, but WITHOUT
  25.  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  26.  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  27.  * details.
  28.  *
  29.  * You should have received a copy of the GNU General Public License along with
  30.  * this program. If not, see <http://www.gnu.org/licenses/>.
  31.  *
  32.  * @author Stephen Ingram <code@jixor.com>
  33.  * @copyright Copyright (c) 2008, Stephen Ingram
  34.  * @package deviantartfeed
  35.  * @category deviantartfeed
  36.  * @todo The title and date regex is quick and dirty, it could easily be tripped
  37.  *        up.
  38.  * @todo Investigate further what sort of output the DeviantART "DiFi" script
  39.  *        will generate.
  40.  */
  41. class deviantartfeed
  42. {
  43.  
  44.     /**
  45.      * Location of config file
  46.      *
  47.      * If you move or rename the deviantart.ini file you must edit this path.
  48.      *
  49.      * @var string 
  50.      */
  51.     const config_file = 'deviantart.ini';
  52.  
  53.     /**
  54.      * Holds loaded config array
  55.      *
  56.      * @var array 
  57.      */
  58.     public $conf;
  59.  
  60.     /**
  61.      * Filesystem path to cache file.
  62.      *
  63.      * @var string 
  64.      */
  65.     public $cache;
  66.  
  67.  
  68.  
  69.     /**
  70.      * Constructor does all the work
  71.      */
  72.     public function __construct()
  73.     {
  74.  
  75.         $this->conf = parse_ini_file(self::config_file, true);
  76.  
  77.         $this->cache = $this->conf['cache']['path']
  78.             . $this->conf['cache']['file'];
  79.  
  80.         if (file_exists($this->cache)
  81.             && filemtime($this->cache) > time() - 86400)
  82.             return $this->output_cache();
  83.  
  84.         /**
  85.          * Set url, broken into multiple lines for readability. Well...
  86.          */
  87.         $url = "http://{$this->conf[feed][user]}artist.deviantart.com/global/difi/"
  88.             . "?c%5B%5D=Resources;htmlFromQuery;gallery%3A{$this->conf[feed][user]}"
  89.             . "%20sort%3Atime,{$this->conf[feed][start]},{$this->conf[feed][request]}"
  90.             . ",thumb150,artist%3A0&t=json";
  91.  
  92.         /**
  93.          * Spoof user agent, not really necessary.
  94.          */
  95.         ini_set(
  96.             'user_agent',
  97.             'Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.9.0.1)'
  98.             );
  99.  
  100.         /**
  101.          * Get json string
  102.          */
  103.         if (!$result = file_get_contents($url))
  104.             return;
  105.  
  106.         /**
  107.          * Decode json string
  108.          */
  109.         $result_object = json_decode($result);
  110.  
  111.         /**
  112.          * Define xml file, includes attributes on channel that are used by the
  113.          * php function calls.
  114.          */
  115.         $xml = "<channel
  116.             imageurl=\"{$this->conf[imagecache][url]}\"
  117.             imagecache=\"{$this->conf[imagecache][path]}\"
  118.             >
  119.             <title>{$this->conf[feed][user]}'s deviantART gallery</title>
  120.             <link>http://{$this->conf[feed][user]}.deviantart.com</link>";
  121.  
  122.         /**
  123.          * Add any additional channel elements as defined in ini
  124.          */
  125.         if (isset($this->conf['channel'])
  126.             && !empty($this->conf['channel'])
  127.             )
  128.             foreach ($this->conf['channel'] as $name => $value)
  129.                 $xml .= "<{$name}>{$value}</{$name}>";
  130.  
  131.         $xml .= "<items>";
  132.  
  133.         /**
  134.          * Add xml entry for each item in the response object.
  135.          */
  136.         foreach($result_object->DiFi->response->calls[0]->response->content->resources as $item)
  137.             $xml .= '<item>' . $item[2] . '</item>';
  138.  
  139.         /**
  140.          * Initialize the dom object and load the xml file from the string.
  141.          */
  142.         $dom = new DOMDocument;
  143.         $dom->loadXML($xml . '</items></channel>');
  144.  
  145.         /**
  146.          * Initialize the xsl dom object and load the xsl file form the
  147.          * filesystem.
  148.          */
  149.         $xsl = new DOMDocument;
  150.         $xsl->load($this->conf['xsl']['path']);
  151.  
  152.         /**
  153.          * Initialize the XSLT processor and enable php function calls
  154.          */
  155.         $proc = new XSLTProcessor();
  156.         $proc->registerPHPFunctions();
  157.  
  158.         /**
  159.          * Import the xsl object
  160.          */
  161.         $proc->importStyleSheet($xsl);
  162.  
  163.         /**
  164.          * Process the xml translation and save to the cache file.
  165.          */
  166.         file_put_contents($this->cache, $proc->transformToXML($dom));
  167.  
  168.         /**
  169.          * Call deviantart::output_cahce() to send the rss feed to the user,
  170.          * if enabled
  171.          */
  172.         return $this->output_cache();
  173.  
  174.     }
  175.  
  176.  
  177.  
  178.     /**
  179.      * Return or send cache depenging on setting
  180.      *
  181.      * If not in cron mode sends the contents of the cache file to the user,
  182.      * otherwise simply returns void.
  183.      *
  184.      * @return void 
  185.      */
  186.     public function output_cache()
  187.     {
  188.  
  189.         if($this->conf['general']['cron'])
  190.             return;
  191.  
  192. /* or redirect to the feed.
  193.         header('Location: '
  194.             . $this->conf['general']['url']
  195.             . $this->conf['cache']['url']
  196.             . $this->conf['cache']['file']
  197.             );
  198. */
  199.  
  200.         if (strpos($_SERVER['HTTP_USER_AGENT'], 'Mozilla')) {
  201.             header('Content-type: text/xml');
  202.         } else {
  203.             header('Content-Type: application/rss+xml');
  204.         }
  205.  
  206.         header('Last-Modified: ' . date('r', filemtime($this->cache)));
  207.  
  208.         echo file_get_contents($this->cache);
  209.  
  210.         return;
  211.  
  212.     }
  213.  
  214.  
  215.  
  216.     /**
  217.      * Downloads a local cache of specified file.
  218.      *
  219.      * @param string $url 
  220.      * @param string $base URL base to apply to output URL
  221.      * @param string $path Path base for local filesystem path.
  222.      * @return string URL to local cache.
  223.      */
  224.     public static function xsl_make_local_cache($url, $base = '', $path = '')
  225.     {
  226.  
  227.         ini_set(
  228.             'user_agent',
  229.             'Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.9.0.1) Gecko/Firefox/3.0.1'
  230.             );
  231.  
  232.         /**
  233.          * Get file name
  234.          */
  235.         $file = substr($url, strrpos($url, '/') + 1);
  236.  
  237.         if (file_exists($path . $file))
  238.             return $base . $file;
  239.  
  240.         file_put_contents($path . $file, file_get_contents($url));
  241.  
  242.         return $base . $file;
  243.  
  244.     }
  245.  
  246.  
  247.  
  248.     /**
  249.      * Gets the artwork title from the proviced string
  250.      *
  251.      * @param string $string Vale of title attribute from input xml
  252.      * @return string Artwork title
  253.      */
  254.     public static function xsl_get_title($string)
  255.     {
  256.  
  257.         preg_match(
  258.             '/(.*?) by/',
  259.             $string,
  260.             $title
  261.             );
  262.  
  263.         return $title[1];
  264.  
  265.     }
  266.  
  267.  
  268.  
  269.     /**
  270.      * Gets the artwork date in RFC 2822 format from the proviced string
  271.      *
  272.      * I'm assuming that deviantart records dates in UTC time, however I could
  273.      * be wrong.
  274.      *
  275.      * @param string $string Vale of title attribute from input xml
  276.      * @return string Artwork date
  277.      */
  278.     public static function xsl_get_date($string)
  279.     {
  280.  
  281.         /**
  282.          * I'm assuming that you can't have a , in your artork title.
  283.          */
  284.         preg_match(
  285.             '/, (.*)/',
  286.             $string,
  287.             $date
  288.             );
  289.  
  290.         date_default_timezone_set('UTC');
  291.  
  292.         return date('r', strtotime($date[1]));
  293.  
  294.     }
  295.  
  296. }
  297.  
  298. new deviantartfeed;
Documentation generated on Thu, 04 Sep 2008 02:21:51 +1000 by phpDocumentor 1.4.1