Changeset 152 for dev

Timestamp:

12/13/06 17:22:00 (14 years ago)

Author:

liq

Message:

liq's feed syndication mod 1.3

Location:

dev

Files:

• common/feed.php (modified) (2 diffs)
• mods/feed_syndication/feed.php (deleted)
• mods/feed_syndication/feed_fetcher.php (modified) (4 diffs)
• mods/feed_syndication/readme.txt (modified) (4 diffs)
• mods/feed_syndication/settings.php (modified) (6 diffs)
• mods/feed_syndication/v1.3 (added)

dev/common/feed.php

@@ -1 +1 @@
 <?php
+        //////
+//////  //////
+//////  liq's feed syndication mod v1.3
+////////////
+////////////
+////////////
+////////////
+ 
+
 @set_time_limit(0);
-
-// based on liq's feed syndication
 require_once("class.corp.php");
 require_once("class.alliance.php");
@@ -10 +17 @@
 require_once("globals.php");
 
-$html .= "
-<rss version=\"2.0\">
-<channel>
-<title>".KB_TITLE."</title>
-<description>Kill Feed</description>
-<link>".KB_HOST."</link>
-<copyright>".KB_TITLE."</copyright>\n";
-
-$klist = new KillList();
-$klist->setPodsNoobShips(true);
-
-if ($_GET['week'])
-{
-    $klist->setWeek($_GET['week']);
-}
-elseif (!$_GET['lastkllid'])
-{
-    $klist->setWeek(date("W"));
-}
-if ($_GET['lastkllid'])
-{
-    if (method_exists($klist, 'setMinKllID'))
-    {
-        $klist->setMinKllID($_GET['lastkllid']);
-    }
-}
-
-if ($_GET['corp'])
-{
-    $_GET['corp_name'] = $_GET['corp'];
-}
-elseif ($_GET['alli'])
-{
-    $_GET['alliance_name'] = $_GET['corp'];
-}
-if ($_GET['corp_name'])
-{
-    $corp = new Corporation();
-    $corp->lookup($_GET['corp_name']);
-    if ($_GET['losses'])
-    {
-        $klist->addVictimCorp($corp);
-    }
-    else
-    {
-        $klist->addInvolvedCorp($corp);
-    }
-}
-elseif ($_GET['alliance_name'])
-{
-    $ally = new Alliance();
-    $ally->add($_GET['alliance_name']);
-    if ($_GET['losses'])
-    {
-        $klist->addVictimAlliance($ally);
-    }
-    else
-    {
-        $klist->addInvolvedAlliance($ally);
-    }
-}
-
-$kills = array();
-while ($kill = $klist->getKill())
-{
-    $kills[$kill->getID()] = $kill->getTimestamp();
-}
-asort($kills);
-
-foreach ($kills as $id => $timestamp)
-{
-        $kill = new Kill($id);
-    $html .= "<item>
-        <title>".$id."</title>
-        <description> <![CDATA[ ".$kill->getRawMail()." ]]>     </description>
-        <guid>?a=kill_detail&amp;kll_id=".$id."</guid>
-    <pubDate>".strftime("%a, %d %b %Y %T %Z" , strtotime($timestamp))."</pubDate>
-        </item>\n";
-}
-$html .= "
+  $html .= "
+        <rss version=\"2.0\">
+        <channel>
+        <title>" . KB_TITLE . "</title>
+        <description>Kill Feed v1.3</description>
+        <link>" . KB_HOST . "</link>
+        <copyright>" . KB_TITLE . "</copyright>\n";
+  
+  $klist = new KillList();
+  $klist->setPodsNoobShips(true);
+  
+  if ($_GET['week'])
+  {
+      $klist->setWeek($_GET['week']);
+  }
+  elseif (!$_GET['lastkllid'])
+  {
+      $klist->setWeek(date("W"));
+  }
+  if ($_GET['lastkllid'])
+  {
+      if (method_exists($klist, 'setMinKllID'))
+      {
+          $klist->setMinKllID($_GET['lastkllid']);
+      }
+  }
+  
+  if ($_GET['corp'] || $_GET['corp_name'])
+  {
+      if ($_GET['corp'])
+      {
+          $c = $_GET['corp'];
+      }
+      if ($_GET['corp_name'])
+      {
+          $c = $_GET['corp_name'];
+      }
+      $corp = new Corporation();
+      $corp->lookup(urldecode($c));
+  }
+  
+  if ($_GET['alli'] || $_GET['alliance_name'])
+  {
+      if ($_GET['alli'])
+      {
+          $a = $_GET['alli'];
+      }
+      if ($_GET['alliance_name'])
+      {
+          $a = $_GET['alliance_name'];
+      }
+      $alli = new Alliance();
+      $alli->add(urldecode($a));
+  }
+  
+  if ($_GET['week'])
+  {
+      $klist->setWeek($_GET['week']);
+  }
+  elseif (!$_GET['lastkllid'])
+  {
+      $klist->setWeek(date("W"));
+  }
+  
+  if ($_GET['losses'])
+  {
+      if (CORP_ID)
+      {
+          $klist->addVictimCorp(new Corporation(CORP_ID));
+      }
+      if (ALLIANCE_ID)
+      {
+          $klist->addVictimAlliance(new Alliance(ALLIANCE_ID));
+      }
+      if ($corp)
+      {
+          $klist->addInvolvedCorp($corp);
+      }
+      if ($alli)
+      {
+          $klist->addInvolvedAlliance($alli);
+      }
+  }
+  else
+  {
+      if (CORP_ID)
+      {
+          $klist->addInvolvedCorp(new Corporation(CORP_ID));
+      }
+      if (ALLIANCE_ID)
+      {
+          $klist->addInvolvedAlliance(new Alliance(ALLIANCE_ID));
+      }
+      if ($corp)
+      {
+          $klist->addVictimCorp($corp);
+      }
+      if ($alli)
+      {
+          $klist->addVictimAlliance($alli);
+      }
+  }
+  
+  $kills = array();
+  while ($kill = $klist->getKill())
+  {
+      $kills[$kill->getID()] = $kill->getTimestamp();
+  }
+  asort($kills);
+  
+  foreach ($kills as $id => $timestamp)
+  {
+      $kill = new Kill($id);
+      $html .= "<item>
+<title>" . $id . "</title>
+<description> <![CDATA[ " . $kill->getRawMail() . " ]]>  </description>
+<guid>?a=kill_detail&amp;kll_id=" . $id . "</guid>
+<pubDate>" . strftime("%a, %d %b %Y %T %Z", strtotime($timestamp)) . "</pubDate>
+</item>\n";
+  }
+  $html .= "
 </channel>
 </rss>";
+  
+  if ($_GET['gz'])
+  {
+      echo gzdeflate($html, 9);
+  }
+  else
+  {
+      echo $html;
+  }
+?>
 
-if ($_GET['compress'] == '1')
-{
-    echo gzdeflate($html);
-}
-else
-{
-    echo $html;
-}
-?>

dev/mods/feed_syndication/feed_fetcher.php

@@ -1 +1 @@
 <?php
+        //////
+//////  //////
+//////  liq's feed syndication mod v1.3
+////////////
+////////////
+////////////
+////////////
+ 
 
-// liq's feed syndication mod v1.2
-
-  @set_time_limit(0);
-  require_once( "class.kill.php" );
-  require_once( "class.parser.php" );
-  if ( file_exists("../../common/class.comments.php") ) // for the Eve-Dev Comment Class
+@set_time_limit(0);
+require_once( "common/class.kill.php" );
+require_once( "common/class.parser.php" );
+if ( file_exists("../../common/class.comments.php") ) // for the Eve-Dev Comment Class
         require_once( "class.comments.php" );
-  if ( file_exists("../../common/class.comment.php") ) // for the D2 Killboard Comment Class
+if ( file_exists("../../common/class.comment.php") ) // for the D2 Killboard Comment Class
         require_once( "class.comment.php" );
 
@@ -53 +59 @@
 class Fetcher {
 
-function grab($url) {
-                global $x, $fetchurl;
+function grab($url, $str) {
+                global $x, $uurl;
                 $x=0;
-                $fetchurl = $url;
+                $fetchurl = $url.$str;
+                $uurl = $url;
         $xml_parser = xml_parser_create();
                 xml_set_object ( $xml_parser, $this );
                 xml_set_element_handler($xml_parser, "startElement", "endElement");
                 xml_set_character_data_handler ( $xml_parser, 'characterData' );
-                $fp = @fopen($url,"r");
-                while ($data = @fread($fp, 4096)) {
-                        if (!xml_parse( $xml_parser, $data, feof($fp) ) && !feof($fp) )
-                                return "<i>Error getting XML data from ".$url."</i><br><br>";
+                $fp = @fopen($fetchurl,"r"); 
+                while ($chunk = @fread($fp, 4096)) {
+                        $data .= $chunk;
                 }
+                $data = preg_replace('<<!--.*?-->>', '', $data); // remove <!-- Cached --> message, else it will break gzinflate
+                
+                if (!@gzinflate($data)) {
+                        $cprs = "raw HTML stream";
+                } else { 
+                        $data = gzinflate($data);
+                        $cprs = "GZip compressed stream";
+                }       
+                
+                if (!xml_parse( $xml_parser, $data, feof($fp) ) && !feof($fp) )
+                        return "<i>Error getting XML data from ".$url."</i><br><br>";           
+                        
                 @fclose($fp);
                 xml_parser_free($xml_parser);
+                
                 if ($x)
-                        $html = "<div class=block-header2>".$x." kills added from feed: ".$url."</div>";
+                        $html .= "<div class=block-header2>".$x." kills added from feed: ".$url." <i>(".$cprs.")</i></div>";
                 else
-                        $html = "<div class=block-header2>No kills added from feed: ".$url."</div>";
+                        $html .= "<div class=block-header2>No kills added from feed: ".$url." <i>(".$cprs.")</i></div>";
+                //echo "url:".$url." --- ";
+                //echo " strg:".$str;
+                
 return $html;
 }
@@ -84 +106 @@
 
 function endElement($parser, $name) {
-        global $insideitem, $tag, $title, $description, $link, $html, $x, $fetchurl;
+        global $insideitem, $tag, $title, $description, $link, $html, $x, $uurl;
 
         if ($name == "ITEM") {
@@ -105 +127 @@
                                 if (class_exists('Comments') && getConfig('fetch_comment')) { // for the Eve-Dev Comment Class
                                         $comments = new Comments($killid);
-                        $comments->addComment("liq's feed syndication", getConfig('fetch_comment')." (mail fetched from: ".$fetchurl.")");
+                        $comments->addComment("liq's feed syndication", getConfig('fetch_comment')." mail fetched from: ".$uurl.")");
                                 }
                                 if (class_exists('Comment') && getConfig('fetch_comment')) { // for the D2 Killboard Comment Class
                                         $comment = new Comment($killid);
-                        $comment->postComment(getConfig('fetch_comment')." \n\n <i>(mail fetched from:\n ".$fetchurl.")</i>", "liquidism");
+                        $comment->postComment(getConfig('fetch_comment')." \n\n\n <i>mail fetched from:\n ".$uurl."</i>", "liquidism");
                                 }
                                 $x++;

dev/mods/feed_syndication/readme.txt

@@ -1 @@
-
-// liq's feed syndication mod v1.1
+        //////
+//////  //////
+//////  liq's feed syndication mod v1.3
+////////////
+////////////
+////////////
+////////////
 
 
 
-//installation:
+//INSTALLATION:
 
-1. put all the files in your /common directory.
+1. create directory mods/feed
+2. put the files settings.php and feed_fetcher.php in /mods/feed_syndication directory.
+3. put feed.php in your /common directory
+3. login as admin and enable the feed-mod in 'Mods'
+4. wee. youre done.
 
-2. add the following line to admin_menu.php:
-$menubox->addOption( "Feeds", "?a=admin_feed" );
-
-3. youre done.
+additionally you can add the following line to common/admin_menu.php for direct access:
+$menubox->addOption( "Feeds", "?a=settings_feed_syndication" );
+or if you use eve-dev kilboard version 1.2.0 and above (using smarty templates):
+$menubox->addOption("link", "Feeds", "?a=settings_feed_syndication");
 
 
-//files
+
+//FILES:
 
 feed.php <- prints out all kills of the actual week in rss format.
@@ -23 +33 @@
 
 
-//notes
 
--> enter feed urls in the format 'http://killboard.eve-d2.com/?a=feed' into the admin interface.
-click 'save' to save your changes before you 'fetch' new kills.
+//NOTES:
+
+-> enter feed urls in the format: http://killboard.eve-d2.com/?a=feed
+
+-> a list of known feeds can be found here: http://www.eve-dev.net/e107_plugins/forum/forum_viewtopic.php?1896
 
 -> clicking the 'fetch' button will get all kills of the actual week.
 
--> ticking the 'grab-ALL-mails-box' will grab ALL kills! be careful with this option!
-** it can take several minutes or even hours to have all the kills parsed and added to your database **
-** be patient. don't close your browser, don't reload. you only need to use this ONCE in a lifetime **
+-> ticking the 'grab-ALL-mails-box' will grab the kills of ALL weeks (iteration from week #1 through to week #52)!
+** be careful with this option! it can take several minutes or even hours to have all the kills parsed and added to your database **
+** be patient. don't close your browser, don't reload. you only need to use this ONCE to initialize a feed connection.
+after initializing, weekly updates are totally sufficient to keep your board uptodate **
+
+-> by default their kills aka. your losses get fetched unless you tick the 'get kills'
+option in which case their losses aka. your kills get fetched
+
+-> GZip compression is enabled by default because the board automatically
+checks and decides if a fetched stream supports GZip compression - if not it uses regular html/rss output.
+
+-> if you are running a master killboard (eg. to supply and share killdata with other killboards) edit settings.php and set 'MASTER' to 1.
+the board will then even fetch kills not related to the alliance or corp ID you set in the killboards config.php.
+leave this option untouched if youre running a normal killboard for your corp or alliance - it will just slow things down.
+
+-> the feed is not supposed to be human readable so ffs dont complain about the formatting,
+for human readable rss output use the rss mod ( /?a=rss ) instead.
 
 
-//changes
+
+//VERSION CHANGES:
+
+//v1.3
+
+feed.php:
+- added support for GZip compressed output
+- minor code cleanups
+
+feed_fetcher.php:
+- converted to a mod
+- added support for getting GZip compressed feeds and a fallback if the feed is uncompressed
+- changed the text in auto-comment to only show the remote killboards url and not the 
+complete path with all passed variables, making it more readable
+
+admin_feed.php / settings.php
+- converted to a mod 
+- renamed to settings.php
+- added option to fetch streams with Gzip compression - enabled by default
+- added support for master killboards whose only purpose is to collect and share kill data, see notes
+
+
+//v1.2
+
+feed.php:
+- added output of feed's version number
+
+feed_fetcher.php:
+- none
+
+admin_feed.php
+- rearranged options to be inline with other admin settings pages
+- added checkboxes to enable / disable fetching specific feed urls
+
 
 //v1.1
@@ -50 +109 @@
 - included calls to the killboards comment function so you can add predefined comments to autoparsed kills aka. "post your losses noob".
 
-admin_feed.php
+admin_feed.php:
 - made the number of feeds user selectable
 - more detailed descriptions
@@ -56 +115 @@
 - option to automatically enter a comment with the autoparsed kill
 - option to get kills instead of losses
+- added backwards compatibility to exi's v1.0 mod
 
 

dev/mods/feed_syndication/settings.php

@@ -1 @@
-<?
+<?php
+        //////
+//////  //////
+//////  liq's feed syndication mod v1.3
+////////////
+////////////
+////////////
+////////////
 
-// liq's feed syndication mod v1.2
+
+// set this to 1 if you are running a master killboard and want 
+// to even fetch mails not related to your corp / alliance
+define( MASTER, 0 );
+
+
 
 @set_time_limit(0);
+require_once( "feed_fetcher.php" );
 require_once( "common/class.page.php" );
 require_once( "common/admin_menu.php" );
-require_once( "common/feed_fetcher.php" );
 require_once( 'common/class.corp.php' );
 require_once( 'common/class.alliance.php' );
@@ -35 +47 @@
                 else
                         setConfig('fetch_verbose', '0');
+                
+                if ( $_POST['fetch_compress'] )
+                        setConfig('fetch_compress', '0');
+                else
+                        setConfig('fetch_compress', '1');
 
                 if ( $_POST['fetch_comment'] )
@@ -61 +78 @@
 
         if ( $_POST['fetch'] ) {
-         if (CORP_ID) {
-             $corp = new Corporation(CORP_ID);
+         if (CORP_ID && !MASTER) {
+                         $corp = new Corporation(CORP_ID);
              $myid = '&corp='.urlencode($corp->getName());
          }
-         if (ALLIANCE_ID) {
+         if (ALLIANCE_ID && !MASTER) {
              $alli = new Alliance(ALLIANCE_ID);
              $myid = '&alli='.urlencode($alli->getName());
-                 }
+                }
 
                  for ($i=1; $i<=$feedcount; $i++) {
@@ -79 +96 @@
                                 if ( $_POST['fetch_losses'] )
                         $str .= "&losses=1";
+                                if ( !getConfig('fetch_compress') )
+                        $str .= "&gz=1";
                                 if ( $_POST['graball'] ) {
                                         for ($l = 1; $l<=52; $l++) {
                                                 $html .= "<b>Week: ". $l ."</b><br>";
-                                                $html .= $feedfetch->grab( $feed[$i].$myid.$str."&week=".$l );
+                                                $html .= $feedfetch->grab( $feed[$i]."&week=".$l, $myid.$str );
                                         }
                             } else
-                                $html .= $feedfetch->grab( $feed[$i].$myid.$str );
+                                $html .= $feedfetch->grab( $feed[$i], $myid.$str );
                         }
 
@@ -93 +112 @@
         }
 
-        $html .= "<form id=options name=options method=post action=?a=admin_feed>";
+        $html .= "<form id=options name=options method=post action=?a=settings_feed>";
     $html .= "</table>";
 
@@ -133 +152 @@
         $html .= "\"><br><i> (leave blank for none)</i><br></td></tr>";
 
+        $html .= "<tr><td height=30px width=150px><b>Enable compression?</b></td>";
+    $html .= "<td><input type=checkbox name=fetch_compress id=fetch_compress";
+        if ( !getConfig('fetch_compress') )
+                $html .= " checked=\"checked\"";
+        $html .= "><i> (enables GZip compression for feeds that support this feature, for streams that do not support GZip compression regular html mode will be used automatically)</i></td>";
+        $html .= "</tr>";
+        
         $html .= "<tr><td height=30px width=150px><b>Verbose mode?</b></td>";
     $html .= "<td><input type=checkbox name=fetch_verbose id=fetch_verbose";
         if ( getConfig('fetch_verbose') )
                 $html .= " checked=\"checked\"";
-        $html .= "><i> (displays errormessages when the imported mail is malformed, already exists, is not related etc.)</i></td>";
+        $html .= "><i> (displays errormessages when the imported mail is rejected for being malformed, already existing, not being related etc.)</i></td>";
         $html .= "</tr></table><br><br>";