Akismet.class.php

Go to the documentation of this file.

<?php
 
class Akismet {
    private $version = '0.5';
    private $wordPressAPIKey;
    private $blogURL;
    private $comment;
    private $apiPort;
    private $akismetServer;
    private $akismetVersion;
    private $requestFactory;
 
    // This prevents some potentially sensitive information from being sent accross the wire.
    private $ignore = array('HTTP_COOKIE',
                            'HTTP_X_FORWARDED_FOR',
                            'HTTP_X_FORWARDED_HOST',
                            'HTTP_MAX_FORWARDS',
                            'HTTP_X_FORWARDED_SERVER',
                            'REDIRECT_STATUS',
                            'SERVER_PORT',
                            'PATH',
                            'DOCUMENT_ROOT',
                            'SERVER_ADMIN',
                            'QUERY_STRING',
                            'PHP_SELF' );
 
    public function __construct($blogURL, $wordPressAPIKey) {
        $this->blogURL = $blogURL;
        $this->wordPressAPIKey = $wordPressAPIKey;
 
        // Set some default values
        $this->apiPort = 80;
        $this->akismetServer = 'rest.akismet.com';
        $this->akismetVersion = '1.1';
        $this->requestFactory = new SocketWriteReadFactory();
 
        // Start to populate the comment data
        $this->comment['blog'] = $blogURL;
 
        if(isset($_SERVER['HTTP_USER_AGENT'])) {
            $this->comment['user_agent'] = $_SERVER['HTTP_USER_AGENT'];
        }
 
        if(isset($_SERVER['HTTP_REFERER'])) {
            $this->comment['referrer'] = $_SERVER['HTTP_REFERER'];
        }
 
        /*
         * This is necessary if the server PHP5 is running on has been set up to run PHP4 and
         * PHP5 concurently and is actually running through a separate proxy al a these instructions:
         * http://www.schlitt.info/applications/blog/archives/83_How_to_run_PHP4_and_PHP_5_parallel.html
         * and http://wiki.coggeshall.org/37.html
         * Otherwise the user_ip appears as the IP address of the PHP4 server passing the requests to the
         * PHP5 one...
         */
        if(isset($_SERVER['REMOTE_ADDR']) && $_SERVER['REMOTE_ADDR'] != getenv('SERVER_ADDR')) {
            $this->comment['user_ip'] = $_SERVER['REMOTE_ADDR'];
        } else {
            $this->comment['user_ip'] = getenv('HTTP_X_FORWARDED_FOR');
        }
    }
 
    public function isKeyValid() {
        // Check to see if the key is valid
        $response = $this->sendRequest('key=' . $this->wordPressAPIKey . '&blog=' . $this->blogURL, $this->akismetServer, '/' . $this->akismetVersion . '/verify-key');
        return $response[1] == 'valid';
    }
 
    // makes a request to the Akismet service
    private function sendRequest($request, $host, $path) {
        $http_request  = "POST " . $path . " HTTP/1.0\r\n";
        $http_request .= "Host: " . $host . "\r\n";
        $http_request .= "Content-Type: application/x-www-form-urlencoded; charset=utf-8\r\n";
        $http_request .= "Content-Length: " . strlen($request) . "\r\n";
        $http_request .= "User-Agent: Akismet PHP5 Class " . $this->version . " | Akismet/1.11\r\n";
        $http_request .= "\r\n";
        $http_request .= $request;
 
        $requestSender = $this->requestFactory->createRequestSender();
        $response = $requestSender->send($host, $this->apiPort, $http_request);
 
        return explode("\r\n\r\n", $response, 2);
    }
 
    // Formats the data for transmission
    private function getQueryString() {
        foreach($_SERVER as $key => $value) {
            if(!in_array($key, $this->ignore)) {
                if($key == 'REMOTE_ADDR') {
                    $this->comment[$key] = $this->comment['user_ip'];
                } else {
                    $this->comment[$key] = $value;
                }
            }
        }
 
        $query_string = '';
 
        foreach($this->comment as $key => $data) {
            if(!is_array($data)) {
                $query_string .= $key . '=' . urlencode(stripslashes($data)) . '&';
            }
        }
 
        return $query_string;
    }
 
    public function isCommentSpam() {
        $response = $this->sendRequest($this->getQueryString(), $this->wordPressAPIKey . '.rest.akismet.com', '/' . $this->akismetVersion . '/comment-check');
 
        if($response[1] == 'invalid' && !$this->isKeyValid()) {
            throw new exception('The Wordpress API key passed to the Akismet constructor is invalid.  Please obtain a valid one from http://wordpress.com/api-keys/');
        }
 
        return ($response[1] == 'true');
    }
 
    public function submitSpam() {
        $this->sendRequest($this->getQueryString(), $this->wordPressAPIKey . '.' . $this->akismetServer, '/' . $this->akismetVersion . '/submit-spam');
    }
 
    public function submitHam() {
        $this->sendRequest($this->getQueryString(), $this->wordPressAPIKey . '.' . $this->akismetServer, '/' . $this->akismetVersion . '/submit-ham');
    }
 
    public function setUserIP($userip) {
        $this->comment['user_ip'] = $userip;
    }
 
    public function setReferrer($referrer) {
        $this->comment['referrer'] = $referrer;
    }
 
    public function setPermalink($permalink) {
        $this->comment['permalink'] = $permalink;
    }
 
    public function setCommentType($commentType) {
        $this->comment['comment_type'] = $commentType;
    }
 
    public function setCommentAuthor($commentAuthor) {
        $this->comment['comment_author'] = $commentAuthor;
    }
 
    public function setCommentAuthorEmail($authorEmail) {
        $this->comment['comment_author_email'] = $authorEmail;
    }
 
    public function setCommentAuthorURL($authorURL) {
        $this->comment['comment_author_url'] = $authorURL;
    }
 
    public function setCommentContent($commentBody) {
        $this->comment['comment_content'] = $commentBody;
    }
 
    public function setCommentUserAgent($userAgent) {
        $this->comment['user_agent'] = $userAgent;
    }
 
    public function setAPIPort($apiPort) {
        $this->apiPort = $apiPort;
    }
 
    public function setAkismetServer($akismetServer) {
        $this->akismetServer = $akismetServer;
    }
 
    public function setAkismetVersion($akismetVersion) {
        $this->akismetVersion = $akismetVersion;
    }
 
    public function setRequestFactory($requestFactory) {
        $this->requestFactory = $requestFactory;
    }
}
 
class SocketWriteRead implements AkismetRequestSender {
    private $response;
    private $errorNumber;
    private $errorString;
 
    public function __construct() {
        $this->errorNumber = 0;
        $this->errorString = '';
    }
 
    public function send($host, $port, $request, $responseLength = 1160) {
        $response = '';
 
        $fs = fsockopen($host, $port, $this->errorNumber, $this->errorString, 3);
 
        if($this->errorNumber != 0) {
            throw new Exception('Error connecting to host: ' . $host . ' Error number: ' . $this->errorNumber . ' Error message: ' . $this->errorString);
        }
 
        if($fs !== false) {
            @fwrite($fs, $request);
 
            while(!feof($fs)) {
                $response .= fgets($fs, $responseLength);
            }
 
            fclose($fs);
        }
 
        return $response;
    }
 
    public function getResponse() {
        return $this->response;
    }
 
    public function getErrorNumner() {
        return $this->errorNumber;
    }
 
    public function getErrorString() {
        return $this->errorString;
    }
}
 
class SocketWriteReadFactory implements AkismetRequestFactory {
 
    public function createRequestSender() {
        return new SocketWriteRead();
    }
}
 
interface AkismetRequestSender {
 
    public function send($host, $port, $request, $responseLength = 1160);
}
 
interface AkismetRequestFactory {
 
    public function createRequestSender();
}
 
?>