inc/classes/third_party/api/primusportal/class_PrimeraApi.php

   1 <?php
   2 /**
   3  * PrimusInterface
   4  * -------------------------------------------
   5  * Mit dieser Klasse ist ein einfacher Primeratransfer von Ihrem Account
   6  * zu dem Account eines bei Primusportal.de registrierten Mitglieds möglich.
   7  *
   8  *------------------ Aenderungen durch Roland Haeder 09.08.2008 ----------------
   9  * Klasse umbenannt nach PrimeraApi, damit sie in das Framework besser passt.
  10  * Zudem sind alle oeffentlichen Attribute nun privat, der Konstruktor hat den
  11  * neuen "magischen" Namen __construct() und "normale" Konstanten sind nach
  12  * Klassenkonstanten umbenannt. Unsinnige else-Bloecke sind noch umgewandelt.
  13  * Methodennamen fangen nun immer mit einem kleinen Buchstaben an. Zudem sind
  14  * die Methoden Pay,Query und Parse umbenannt.
  15  *------------------ Aenderungen durch Roland Haeder 09.08.2008 ----------------
  16  *
  17  * Die Einbindung des Interfaces geschieht folgendermaßen:
  18  *  1. Einbindung der Klasse in Ihr PHP-Auszahlungsskript:
  19  *     CODE:
  20  *       require( "PFAD/ZU/DER/KLASSE/PrimusInterface.class.php" );
  21  *       $PPUsername = "username"; // Ihr Username bei Primusportal
  22  *       $PPPassword = "passwort"; // Ihr Passwort bei Primusportal
  23  *
  24  *       $Interface = new PrimusInterface($PPUsername, $PPPassword);
  25  *  2. Durchführen einer Auszahlung:
  26  *     CODE:
  27  *       $Status = $Interface->payPrimera($PayReceiver, $PayAmount, $PayDescription);
  28  *
  29  *     Wobei $PayReicer der Username des Empfängers bei
  30  *     Primusportal.de ist. $PayAmount ist der gerundete( !! ) Betrag an Primera,
  31  *     die der Empfänger erhalten soll. $PayDescription ist eine von Ihnen
  32  *     festgelegte kurze Beschreibung. Die Länge dieses Textes darf 100 Zeichen
  33  *     nicht überschreiten. Beispiel:
  34  *       $status = $Interface->payPrimera("garbage", 10000, "Auszahlung IhreSeite.de - ID: 12345");
  35  *  3. Überprüfung des Status (Rückgabecode):
  36  *     CODE:
  37  *       if (!$status) {
  38  *         // Ein Fehler ist aufgetreten
  39  *     // Fehlerbehandlung hier einfügen...
  40  *       }else {
  41  *         // Auszahlung erfolgreich durchgeführt
  42  *         // Führen Sie hier Ihre Datenbankabfragen durch, um die Auszahlung zu
  43  *         // bestätigen...
  44  *       }
  45  *
  46  *     Die komplette Rückgabe des Interfaces wird als assoziatives Array in der Klassen-
  47  *     variable __data gespeichert:
  48  *     __data => array('status' => Rückgabecode (PI_DONE, PI_SENDER_ERROR, ...),
  49  *                     "statustext" => Status in Worten (z.B.: "Transaktion erfolgreich durchgeführt"),
  50  *                     ")
  51  *
  52  *
  53  * @author              Andreas Schmidt <xxgarbagexx@web.de>
  54  * @author              Roland Haeder <webmaster@ship-simu.org>
  55  * @version             1.0 - beta
  56  * @copyright   (c) 2007 by Primusportal.de
  57  * @copyright   (c) 2008 by Roland Haeder
  58  */
  59 class PrimeraApi extends BaseFrameworkSystem {
  60         /**
  61          * Fehler - Interfacebenutzer
  62          */
  63         const PI_ERROR = -1;
  64
  65         /**
  66          * Statuscode für erfolgreich ausgeführte Transaktion
  67          */
  68         const PI_DONE = 200;
  69
  70         /**
  71          * Fehler - User existiert nicht oder ist gesperrt
  72          */
  73         const PI_RECEIVER_ERROR = 301;
  74
  75         /**
  76          * Sender-Account Fehler (User nicht existent, gesperrt, ...)
  77          */
  78         const PI_SENDER_ERROR = 401;
  79
  80         /**
  81          * Betrag fehler
  82          */
  83         const PI_AMOUNT_ERROR = 501;
  84
  85         /**
  86          * Zu wenig Primera
  87          */
  88         const PI_TOO_LESS_PRIMERA = 502;
  89
  90         /**
  91          * User nicht aktiv oder existiert nicht
  92          */
  93         const PI_USER_CHECK_ERROR = 601;
  94
  95         /**
  96          * User aktiv
  97          */
  98         const PI_USER_CHECK_OK = 602;
  99
 100         /**
 101          * Primerastand erfolgreich geholt
 102          */
 103         const PI_GET_PRIMERA_DONE = 701;
 104
 105         /**
 106          * URL für das Interface auf dem Primusserver:
 107          */
 108         private $host = "www.primusportal.de";
 109         private $path = "/transfer.interface.2.0.php";
 110
 111         private $errno = 0;
 112         private $err = '';
 113
 114         private $seperator = ':';
 115
 116         private $username = '';
 117         private $password = '';
 118
 119         private $data = array();
 120
 121         /**
 122          * Konstruktor
 123          */
 124         public function __construct ($PPUsername, $PPPassword) {
 125                 // Call parent constructor
 126                 parent::__construct();
 127
 128                 // Set data (DEPRECATED!)
 129                 $this->username = $PPUsername;
 130                 $this->password = $PPPassword;
 131         }
 132
 133         /**
 134          * Anfrage senden und Rueckgabecode in Variable speichern
 135          */
 136         function queryApi ( $data = array() ) {
 137                 $fp = fsockopen($this->host, 80, $this->errno, $this->_err);
 138                 if (!$fp) return false;
 139
 140                 $data["PrimusInterface_Username"] = base64_encode($this->username);
 141                 $data["PrimusInterface_Password"] = base64_encode(md5($this->password));
 142
 143                 // POST-Daten uebermitteln:
 144                 $data = http_build_query($data, '', '&');
 145
 146                 fputs($fp, "POST {$this->path}HTTP/1.1\r\n");
 147                 fputs($fp, "Host: {$this->host}\r\n");
 148                 fputs($fp, "Content-type: application/x-www-form-urlencoded\r\n");
 149                 fputs($fp, "Content-length: ". strlen($data) ."\r\n");
 150                 fputs($fp, "Connection: close\r\n\r\n");
 151                 fputs($fp, $data);
 152
 153                 $return = '';
 154                 while (!feof($fp)) {
 155                         $return.=fgets($fp,128);
 156                 }
 157
 158                 $content = explode("<!-- return-start -->", $return);
 159                 return $content[1];
 160         }
 161
 162         /**
 163          * Funktion parst die Rückgabe vom Transferskript:
 164          */
 165         function parseContent ( $content ) {
 166                 $x = explode("\n", $content);
 167                 $return = array();
 168                 foreach($x as $currentLine) {
 169                         $line_exploded = explode($this->seperator, $currentLine,2);
 170                         if (count($line_exploded) > 1) {
 171                                 $return[$line_exploded[0]] = $line_exploded[1];
 172                         }
 173                 }
 174                 return $return;
 175         }
 176
 177         /**
 178          * @param int/string $Receiver UserID / Username des Empfängers
 179          * @param int$Amount Betrag in ganzzahligen Primera
 180          * @param string $Description Beschreibung (Sichtbar in Einzelauflistung)
 181          */
 182         public function payPrimera ($Receiver, $Amount, $Description = '') {
 183                 $valid = false;
 184                 $PostData = array(
 185                         'PrimusInterface_Action'      => 'Pay',
 186                         'PrimusInterface_Receiver'    => base64_encode($Receiver),
 187                         'PrimusInterface_Amount'      => base64_encode($Amount),
 188                         'PrimusInterface_Description' => base64_encode($Description) );
 189
 190                 $PostReturn = $this->parseContent( $this->queryApi($PostData) );
 191
 192                 $this->data = $PostReturn;
 193                 if ($PostReturn['status'] == '200') {
 194                         $valid = true;
 195                 }
 196                 return $valid;
 197         }
 198
 199         /**
 200          * Überprüft den Status eines Primus-Users
 201          * - existiert der User
 202          * - ist er aktiv
 203          * @param string/int $User Userid / Username
 204          */
 205         function CheckPrimusUser ($User) {
 206                 $valid = false;
 207                 $PostData = array(
 208                         'PrimusInterface_Action'          => 'CheckPrimusUser',
 209                         'PrimusInterface_CheckPrimusUser' => $User);
 210
 211                 $PostReturn = $this->parseContent( $this->queryApi($PostData) );
 212
 213                 $this->data = $PostReturn;
 214
 215                 if ($PostReturn['status'] == self::PI_USER_CHECK_OK) {
 216                         $valid = true;
 217                 }
 218                 return $valid;
 219         }
 220
 221         /**
 222          * Die Funktion liefer den aktuellen Primerastand
 223          */
 224         function getPrimera() {
 225                 $primera = false;
 226                 $PostData = array( "PrimusInterface_Action" => "GetPrimera" );
 227                 $PostReturn = $this->parseContent( $this->queryApi($PostData) );
 228
 229                 $this->data = $PostReturn;
 230                 if ($PostReturn['status'] == self::PI_GET_PRIMERA_DONE) {
 231                         $primera = $PostReturn["primera"];
 232                 }
 233                 return $primera;
 234         }
 235 }
 236
 237 // [EOF]
 238 ?>