Changeset 181

Timestamp:

01/28/07 16:04:10 (14 years ago)

Author:

exi

Message:

Changed admin/options to show the actual page as page title.
admin_menu.php now also loads settings from mods.
Added event manager and the first 2 events (comment/killmail added).
Changed config to be in a separate file and modified it to be called static with config::get().
http_request now stores the socket status in $this->status.
Changed MapView? to store pictures based on KB_SITE so it doesnt show a map with wrong colors for the current killboard on a multi-site installation.
Changed options to handle element options (like 'edit:size:40').
Changed options to use the static calls to config.
Changed Page to use the static calls to config.
Changed Session to use session_name() to determine if it should start a session.
index.php now loads module-init-scripts.
Changed post.php to use config and it should now also use the mailserver configuration directive to send emails.
Added a mail_forward-mod to show how easy it can be to develop mods once there are enough events listed.
Fixed 2 typos in battle_overview.tpl.

Location:

dev

Files:

• common/admin.php (modified) (3 diffs)
• common/admin/admin_generic.php (modified) (2 diffs)
• common/admin_menu.php (modified) (2 diffs)
• common/class.comments.php (modified) (1 diff)
• common/class.config.php (added)
• common/class.event.php (added)
• common/class.http.php (modified) (1 diff)
• common/class.kill.php (modified) (1 diff)
• common/class.killboard.php (modified) (2 diffs)
• common/class.map.php (modified) (4 diffs)
• common/class.options.php (modified) (12 diffs)
• common/class.page.php (modified) (4 diffs)
• common/class.roles.php (added)
• common/class.session.php (modified) (1 diff)
• common/class.tabbedform.php (deleted)
• common/index.php (modified) (6 diffs)
• common/post.php (modified) (4 diffs)
• index.php (modified) (1 diff)
• mods/mail_forward (added)
• mods/mail_forward/auto_settings.php (added)
• mods/mail_forward/init.php (added)
• templates/admin_options_edit.tpl (modified) (1 diff)
• templates/battle_overview.tpl (modified) (2 diffs)

dev/common/admin.php

@@ -3 +3 @@
 require_once('class.killboard.php');
 require_once('class.page.php');
-require_once('class.tabbedform.php');
 
 // admin menu now loads all admin pages with options
@@ -10 +9 @@
 
 $killboard = new Killboard(KB_SITE);
-$page = new Page('Administration - Generic (Current version: '.KB_VERSION.' Build '.SVN_REV.')');
+$page = new Page();
 $page->setAdmin();
 
@@ -41 +40 @@
     $page->setContent(options::genOptionsPage());
     $page->addContext(options::genAdminMenu());
+    if ($_REQUEST['sub'] == 'Generic' && $_REQUEST['field'] == 'Appearance')
+    {
+        $page->setTitle('Administration - Generic (Current version: '.KB_VERSION.' Build '.SVN_REV.')');
+    }
     $page->generate();
 }

dev/common/admin/admin_generic.php

@@ -120 +120 @@
         {
                 $t = mktime(0, 0, 0, $i, 1, 1980);
-                $month = date("M", $t);
+                $month = gmdate("M", $t);
                 if($date['mon'] == $i)
             {
@@ -135 +135 @@
 
         $html .= "<select name=\"option[filter_year]\" id=\"option[filter_year]\">";
-        for ($i = date("Y")-7; $i <= date("Y"); $i++)
+        for ($i = gmdate("Y")-7; $i <= gmdate("Y"); $i++)
         {
                 if ($date['year'] == $i)

dev/common/admin_menu.php

@@ -20 +20 @@
 }
 
+$mods_active = explode(',', config::get('mods_active'));
+$modOverrides = false;
+foreach ($mods_active as $mod)
+{
+    if (file_exists('mods/'.$mod.'/auto_settings.php'))
+    {
+        include('mods/'.$mod.'/auto_settings.php');
+    }
+}
+
 // overload the box object to force every admin page to use the new options menu
 class Box2 extends Box
@@ -38 +48 @@
 options::oldMenu('Advanced', "Synchronization", "?a=admin_sync");
 options::oldMenu('Advanced', "Post Permissions", "?a=admin_postperm");
-options::oldMenu('Modules'," Mods", "?a=admin_mods");
+options::oldMenu('Modules', "Mods", "?a=admin_mods");
 options::oldMenu('Maintenance', "Auditing", "?a=admin_audit");
 options::oldMenu('Maintenance', "Kill Import - files", "?a=kill_import");

dev/common/class.comments.php

@@ -36 +36 @@
         $id = $qry->getInsertID();
         $this->comments_[] = array('time' => date('Y-m-d H:i:s'), 'name' => $name, 'comment' => stripslashes($comment), 'id' => $id);
+
+        // create comment_added event
+        event::call('comment_added', &$this);
     }
 

dev/common/class.http.php

@@ -151 +151 @@
             }
         }
+        $this->status = socket_get_status($fp);
         fclose($fp);
         $this->header = $http_header;

dev/common/class.kill.php

@@ -698 +698 @@
             $qry->execute($sql);
         }
+
+        // call the event that we added this mail
+        event::call('killmail_added', &$this);
         return $this->id_;
     }

dev/common/class.killboard.php

@@ -1 +1 @@
 <?php
 require_once("db.php");
+require_once('class.config.php');
 
 class Killboard
@@ -52 +53 @@
     }
 }
-
-class Config
-{
-    function Config($site)
-    {
-        $this->qry_ = new DBQuery();
-        $this->sql_ = "select * from kb3_config where cfg_site = '".$site."'";
-
-        $this->site_ = $site;
-    }
-
-    function getStyleName()
-    {
-        $this->execQuery();
-        return $this->config['style_name'];
-    }
-
-    function getStyleBanner()
-    {
-        $this->execQuery();
-        return $this->config['style_banner'];
-    }
-
-    function getPostPassword()
-    {
-        $this->execQuery();
-        return $this->config['post_password'];
-    }
-
-    function getPostMailto()
-    {
-        $this->execQuery();
-        return $this->config['post_mailto'];
-    }
-
-    function getKillPoints()
-    {
-        $this->execQuery();
-        return $this->config['kill_points'];
-    }
-
-    function getLeastActive()
-    {
-        $this->execQuery();
-        return $this->config['least_active'];
-    }
-
-    function getConfig($key)
-    {
-        $this->execQuery();
-        if (isset($this->config[$key]))
-        {
-            return $this->config[$key];
-        }
-        return false;
-    }
-
-    function setConfig($key, $value)
-    {
-        $qry = new DBQuery();
-        $qry->execute("select cfg_value from kb3_config
-                       where cfg_key = '".$key."'
-                               and cfg_site = '".$this->site_."'");
-        if ($qry->recordCount())
-        {
-            $sql = "update kb3_config
-                    set cfg_value = '".$value."'
-                    where cfg_site = '".$this->site_."'
-                        and cfg_key = '".$key."'";
-        }
-        else
-        {
-            $sql = "insert into kb3_config values ( '".$this->site_."',
-                                                '".$key."',
-                                                '".$value."' )";
-        }
-        $qry->execute($sql) or die($qry->getErrorMsg());
-        $this->config[$key] = $value;
-    }
-
-    function delConfig($key)
-    {
-        $qry = new DBQuery();
-        $qry->execute("delete from kb3_config where cfg_key = '".$key."'
-                               and cfg_site = '".$this->site_."'");
-        if (isset($this->config[$key]))
-        {
-            unset($this->config[$key]);
-        }
-    }
-
-    function checkCheckbox($name)
-    {
-        if ($_POST[$name] == 'on')
-        {
-            $this->setConfig($name, '1');
-            return true;
-        }
-        $this->setConfig($name, '0');
-        return false;
-    }
-
-    function setStyleName($name)
-    {
-        $this->setConfig("style_name", $name);
-    }
-
-    function setStyleBanner($banner)
-    {
-        $this->setConfig("style_banner", $banner);
-    }
-
-    function setPostPassword($password)
-    {
-        $this->setConfig("post_password", $password);
-    }
-
-    function setPostMailto($mailto)
-    {
-        $this->setConfig("post_mailto", $mailto);
-    }
-
-    function setKillPoints($flag)
-    {
-        $this->setConfig("kill_points", $flag);
-    }
-
-    function setLeastActive($flag)
-    {
-        $this->setConfig("least_active", $flag);
-    }
-
-    function execQuery()
-    {
-        if (!$this->qry_->executed_)
-        {
-            $this->qry_->execute($this->sql_);
-
-            $this->config = array();
-            while ($row = $this->qry_->getRow())
-            {
-                $this->config[$row['cfg_key']] = $row['cfg_value'];
-            }
-            if (count($this->config) == 0)
-            {
-                // no config supplied, generate standard one
-
-                $this->setConfig('style_name', 'default');
-                $this->setConfig('style_banner', 'default');
-                $this->setConfig('kill_points', 1);
-                $this->setConfig('least_active', 0);
-                $this->setConfig('post_password', 'CHANGEME');
-            }
-        }
-    }
-}
 ?>

dev/common/class.map.php

@@ -142 +142 @@
                    and sjp.sjp_from = sys.sys_eve_id';
 
-        $regioncache = "cache/map/" . $this->regionid_ . "_" . $this->imgwidth_ . ".png";
+        $regioncache = 'cache/map/'.KB_SITE.'_'.$this->regionid_.'_'.$this->imgwidth_.'.png';
         $cached = false;
 
@@ -158 +158 @@
         if ($this->mode_ == "region")
         {
-            $sql .= " and reg.reg_id = " . $this->regionid_;
+            $sql .= " and reg.reg_id = ".$this->regionid_;
             $caption = $this->conname_;
         }
@@ -164 +164 @@
         if ($this->mode_ == "cons")
         {
-            $sql .= " and con.con_id = " . $this->conid_;
-            $caption = $this->sysname_ . " (" . roundsec($this->syssec_) . ")";
+            $sql .= " and con.con_id = ".$this->conid_;
+            $caption = $this->sysname_." (".roundsec($this->syssec_).")";
         }
 
@@ -352 +352 @@
         if (strlen($this->title_) > 0)
         {
-            $title = $this->title_ . " " . $caption;
+            $title = $this->title_." ".$caption;
         }
         else

dev/common/class.options.php

@@ -4 +4 @@
 * This is the class which should make it easier to add new options to the admin menu
 * It may only be invoked statically like: options::add(...);
-* Do NOT try to call $options = new options()!!!!!!
+* more functions will be added as needed, if you want one, add it or contact exi
 */
 
@@ -42 +42 @@
     }
 
+    // this will emulate the old options menu
     function oldMenu($field, $subfield, $link)
     {
@@ -49 +50 @@
     }
 
+    // this handles the submit from the optionspage
     function handlePost()
     {
-        global $config;
         $data = &options::_getData();
 
@@ -59 +60 @@
             foreach ($elements as $element)
             {
+                // for callbacks we check their callback function on postdata to deal with it
                 if ($element['callback'])
                 {
@@ -69 +71 @@
                     continue;
                 }
+
+                // for checkboxes we need to set the value to zero if the option is not there
                 if ($element['type'] == 'checkbox')
                 {
                     if ($_POST['option'][$element['name']] == 'on')
                     {
-                        $config->setConfig($element['name'], '1');
+                        config::set($element['name'], '1');
                     }
                     else
                     {
-                        $config->setConfig($element['name'], '0');
+                        config::set($element['name'], '0');
                     }
                 }
                 else
                 {
-                     $config->setConfig($element['name'], $_POST['option'][$element['name']]);
+                    // edits and options will be set directly
+                    config::set($element['name'], $_POST['option'][$element['name']]);
                 }
             }
@@ -95 +100 @@
         $sub = $_REQUEST['sub'];
 
-        global $smarty;
-
+        global $smarty, $page;
+
+        if (is_object($page))
+        {
+            $page->setTitle('Administration - '.$sub);
+        }
+
+        // create the option field
         $smarty->assign('field', $field);
         $smarty->assign('sub', $sub);
         $html = $smarty->fetch(get_tpl('admin_options_field_head'));
+
+        // create all option sets
         foreach ($data[$field][$sub] as $set => $options)
         {
             $smarty->assign('set', $set);
             $html .= $smarty->fetch(get_tpl('admin_options_set_head'));
+
+            // create all options in the set
             foreach ($options as $option)
             {
@@ -118 +133 @@
         global $smarty;
 
+        // this will extract all options into an array
+        $options = array();
+        if (strpos($element['type'], ':'))
+        {
+            $array = explode(':', $element['type']);
+            $element['type'] = array_shift($array);
+
+            $max = count($array);
+            for ($i=0; $i<=$max; $i+=2)
+            {
+                // make sure we assign a value
+                if (isset($array[$i+1]))
+                {
+                    $options[$array[$i]] = $array[$i+1];
+                }
+            }
+        }
+
         if ($element['type'] == 'select')
         {
@@ -141 +174 @@
         {
             $smarty->assign_by_ref('opt', $element);
+
+            if (!$options['size'])
+            {
+                $options['size'] = 20;
+            }
+            if (!$options['maxlength'])
+            {
+                $options['maxlength'] = 80;
+            }
+            $smarty->assign_by_ref('options', $options);
             return $smarty->fetch(get_tpl('admin_options_edit'));
         }
 
+        // for a custom element we call the callback to get the html we want
         if ($element['type'] == 'custom')
         {
@@ -165 +209 @@
         $data = &options::_getData();
 
+        // sort the menu alphabetically
         ksort($data);
+
+        // create a standardbox to print all links into
         $menubox = new Box('Options');
         $menubox->setIcon('menu-item.gif');
@@ -174 +221 @@
             foreach ($subfields as $subfield => $array)
             {
+                // if this subfield has no options then it is a category
                 if (!is_array($array))
                 {
@@ -179 +227 @@
                     continue;
                 }
+
+                // we're not a category, make it klickable
                 $menubox->addOption('link', $subfield, '?a=admin&amp;field='.$field.'&amp;sub='.$subfield);
             }
@@ -186 +236 @@
     }
 
+    // private data storage to store all options
     function &_getData()
     {

dev/common/class.page.php

@@ -46 +46 @@
         $smarty->assign('kb_title', KB_TITLE.' Killboard - '.$this->title_);
 
-        $style = $config->getStyleName();
+        $style = config::get('style_name');
         $smarty->assign('style', $style);
 
@@ -58 +58 @@
         if (!$this->igb_)
         {
-            if (strpos($config->getConfig('mods_active'), 'rss_feed') !== false)
+            if (strpos(config::get('mods_active'), 'rss_feed') !== false)
             {
                 $smarty->assign('rss_feed', 1);
@@ -66 +66 @@
                 $smarty->assign('banner_link', MAIN_SITE);
             }
-            $banner = $config->getStyleBanner();
+            $banner = config::get('style_banner');
             if ($banner == 'custom')
             {
@@ -95 +95 @@
                 $w--;
             }
-            if ($config->getConfig('show_standing'))
+            if (config::get('show_standing'))
             {
                 $w--;

dev/common/class.session.php

@@ -6 +6 @@
     function Session()
     {
-        if (isset($_REQUEST['PHPSESSID']))
+        if (isset($_REQUEST[session_name()]))
         {
             session_start();

dev/common/index.php

@@ -3 +3 @@
 require_once('class.killboard.php');
 require_once('smarty/Smarty.class.php');
+require_once('class.event.php');
+require_once('class.roles.php');
+// smarty doesnt like it (i either)
+@set_magic_quotes_runtime(0);
 
 $page = str_replace('.', '', $_GET['a']);
@@ -10 +14 @@
     $page = 'home';
 }
+
+// check for the igb
 if (substr($_SERVER['HTTP_USER_AGENT'], 0, 15) == 'EVE-minibrowser')
 {
@@ -25 +31 @@
 $killboard = new Killboard(KB_SITE);
 $config = $killboard->getConfig();
+
+// setting up smarty
 $smarty = new Smarty();
 $smarty->template_dir = './templates';
@@ -32 +40 @@
 $smarty->assign('img_url', IMG_URL);
 $smarty->assign_by_ref('config', $config);
+
+// this is to make sure that smarty is able to create output
 if (!is_dir('./cache/templates_c'))
 {
@@ -43 +53 @@
     }
 }
-// if ($killboard->isSuspended())
-// $page = 'suspended';
 
 if (substr($page, 0, 9) == 'settings_')
@@ -58 +66 @@
 foreach ($mods_active as $mod)
 {
+    // load all modules which need initialization
+    if (file_exists('mods/'.$mod.'/init.php'))
+    {
+        include('mods/'.$mod.'/init.php');
+    }
     if (file_exists('mods/'.$mod.'/'.$page.'.php'))
     {

dev/common/post.php

@@ -11 +11 @@
 if (isset($_POST['killmail']))
 {
-    if ($_POST['password'] == $config->getPostPassword() || $page->isAdmin())
+    if ($_POST['password'] == config::get('post_password') || $page->isAdmin())
     {
         $parser = new Parser($_POST['killmail']);
 
         // Filtering
-        if ($config->getConfig("filter_apply"))
+        if (config::get("filter_apply"))
         {
-            $filterdate = $config->getConfig("filter_date");
+            $filterdate = config::get("filter_date");
             $year = substr($_POST['killmail'], 0, 4);
             $month = substr($_POST['killmail'], 5, 2);
@@ -65 +65 @@
             elseif ($killid == -3)
             {
-                $filterdate = date("j F Y", $config->getConfig("filter_date"));
+                $filterdate = date("j F Y", config::get("filter_date"));
                 $html = "You are not allowed to post killmails older than $filterdate.";
             }
@@ -76 +76 @@
                 $kill = new Kill($killid);
 
-                $mailer->From = "mailer@".$config->getConfig('mail_host');
-                $mailer->FromName = $config->getConfig('mail_host');
+                if (!$server = config::get('post_mailserver'))
+                {
+                    $server = 'localhost';
+                }
+                $mailer->From = "mailer@".config::get('post_mailhost');
+                $mailer->FromName = config::get('post_mailhost');
                 $mailer->Subject = "Killmail #" . $killid;
-                $mailer->Host = "localhost";
+                $mailer->Host = $server;
                 $mailer->Port = 25;
-                $mailer->Helo = "localhost";
+                $mailer->Helo = $server;
                 $mailer->Mailer = "smtp";
-                $mailer->AddReplyTo("no_reply@".$config->getConfig('mail_host'), "No-Reply");
-                $mailer->Sender = "mailer@".$config->getConfig('mail_host');
+                $mailer->AddReplyTo("no_reply@".config::get('post_mailhost'), "No-Reply");
+                $mailer->Sender = "mailer@".config::get('post_mailhost');
                 $mailer->Body = $kill->getRawMail();
-                $mailer->AddAddress($config->getPostMailto());
+                $mailer->AddAddress(config::get('post_mailhost'));
                 $mailer->Send();
             }
 
             $qry = new DBQuery();
-            $qry->execute("insert into kb3_log
-                               values(".$killid.",'".KB_SITE."','".$_SERVER['REMOTE_ADDR']."', now())");
+            $qry->execute("insert into kb3_log values(".$killid.",'".KB_SITE."','".$_SERVER['REMOTE_ADDR']."', now())");
 
             header("Location: ?a=kill_detail&kll_id=".$killid);
@@ -103 +106 @@
     }
 }
-elseif (!$config->getConfig('post_forbid'))
+elseif (!config::get('post_forbid'))
 {
     $html .= "Paste the killmail from your EVEMail inbox into the box below. Make sure you post the <b>ENTIRE</b> mail.<br>Posting fake or otherwise edited mails is not allowed. All posts are logged.";

dev/index.php

@@ -1 +1 @@
 <?php
-error_reporting(E_ALL ^ E_NOTICE);
+@error_reporting(E_ALL ^ E_NOTICE);
 include('common/index.php');
 ?>

dev/templates/admin_options_edit.tpl

@@ -2 +2 @@
 <tr><td width="120"><b>{$opt.descr}:</b></td><td>
 <input type="edit" id="option[{$opt.name}]" name="option[{$opt.name}]"
-value="{$config->getConfig($opt.name)}" size="20" maxlength="80">
+value="{$config->getConfig($opt.name)}" size="{$options.size}" maxlength="{$options.maxlength}">
 {if $opt.hint}
 &nbsp;({$opt.hint})

dev/templates/battle_overview.tpl

@@ -33 +33 @@
       <td class="kb-table-cell"><b><a href="?a=pilot_detail&amp;plt_id={$pilot}">{$i.name}</a></b><br/>{$i.ship}</td>
 {/if}
-      <td class="kb-table-cell"><b><a href="?a=corp_detail&amp;crp_id={$i.cid}">{$i.corp}</a></b><br/><a href="?a=alliance_detail&amp;kll_id={$i.aid}" style="font-weight: normal;">{$i.alliance}</a></td>
+      <td class="kb-table-cell"><b><a href="?a=corp_detail&amp;crp_id={$i.cid}">{$i.corp}</a></b><br/><a href="?a=alliance_detail&amp;all_id={$i.aid}" style="font-weight: normal;">{$i.alliance}</a></td>
     </tr>
 {/foreach}
@@ -68 +68 @@
       <td class="kb-table-cell"><b><a href="?a=pilot_detail&amp;plt_id={$pilot}">{$i.name}</a></b><br/>{$i.ship}</td>
 {/if}
-      <td class="kb-table-cell"><b><a href="?a=corp_detail&amp;crp_id={$i.cid}">{$i.corp}</a></b><br/><a href="?a=alliance_detail&amp;kll_id={$i.aid}" style="font-weight: normal;">{$i.alliance}</a></td>
+      <td class="kb-table-cell"><b><a href="?a=corp_detail&amp;crp_id={$i.cid}">{$i.corp}</a></b><br/><a href="?a=alliance_detail&amp;all_id={$i.aid}" style="font-weight: normal;">{$i.alliance}</a></td>
     </tr>
 {/foreach}