application/hub/main/database/wrapper/class_PeerStateLookupDatabaseWrapper.php

   1 <?php
   2 /**
   3  * A database wrapper for peer state lookups
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 Hub Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.org
  10  *
  11  * This program is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation, either version 3 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  23  */
  24 class PeerStateLookupDatabaseWrapper extends BaseDatabaseWrapper {
  25         // Constants for database table names
  26         const DB_TABLE_PEER_LOOKUP = 'peer_states';
  27
  28         // Constants for database column names
  29         const DB_COLUMN_PEER_IP    = 'peer_ip';
  30
  31         /**
  32          * Protected constructor
  33          *
  34          * @return      void
  35          */
  36         protected function __construct () {
  37                 // Call parent constructor
  38                 parent::__construct(__CLASS__);
  39         }
  40
  41         /**
  42          * Creates an instance of this database wrapper by a provided user class
  43          *
  44          * @return      $wrapperInstance        An instance of the created wrapper class
  45          */
  46         public final static function createPeerStateLookupDatabaseWrapper () {
  47                 // Get a new instance
  48                 $wrapperInstance = new PeerStateLookupDatabaseWrapper();
  49
  50                 // Set (primary!) table name
  51                 $wrapperInstance->setTableName(self::DB_TABLE_PEER_LOOKUP);
  52
  53                 // Return the instance
  54                 return $wrapperInstance;
  55         }
  56
  57         /**
  58          * Getter for index key
  59          *
  60          * @return      $indexKey       Index key
  61          */
  62         public final function getIndexKey () {
  63                 return $this->getDatabaseInstance()->getIndexKey();
  64         }
  65
  66         /**
  67          * Checks wether given 'sender' is a new peer
  68          *
  69          * @param       $packageData    Raw package data
  70          * @return      $isNewPeer              Wether 'sender' is a new peer to this node
  71          */
  72         public function isSenderNewPeer (array $packageData) {
  73                 // Get a search criteria instance
  74                 $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
  75
  76                 // Add 'sender' as the peer's IP (this must already be looked up!)
  77                 $searchInstance->addCriteria(self::DB_COLUMN_PEER_IP, $packageData['sender']);
  78                 $searchInstance->setLimit(1);
  79
  80                 // Count the query
  81                 $entries = $this->doSelectCountByCriteria($searchInstance);
  82
  83                 // Is it there?
  84                 $isNewPeer = ($entries === 0);
  85
  86                 // Return the result
  87                 return $isNewPeer;
  88         }
  89 }
  90
  91 // [EOF]
  92 ?>