sunnysideup / silverstripe-hidemailto

code/HideMailto.php

<?php


class HideMailto extends SiteTreeExtension
{
    private static $email_field = "Email";

    private static $default_subject = "enquiry";

    private static $replace_characters = array(

The property $replace_characters is not used and could be removed.

        "." => ".",
        "@" => "@",
        "a" => "a",
        "b" => "b",
        "c" => "c",
        "d" => "d",
        "e" => "e",
        "f" => "f",
        "g" => "g",
        "h" => "h",
        "i" => "i"
    );

    /**
     *
     * @param String $email
     * @param String $subject
     * @return Obj (MailTo, Text, Original, Subject)
     */
    public static function convert_email($email, $subject = '')
    {
        $obj = new ViewableData();
        if (!$subject) {
            $subject = self::$default_subject;
        }
        //mailto part
        $mailTo = "mailto:".$email."?subject=".Convert::raw2mailto($subject);
        $mailToConverted = self::string_encoder($mailTo);
        $convertedEmail = self::string_encoder($email);
        $obj->MailTo = $mailToConverted;
        $obj->Text = $convertedEmail;
        $obj->Original = $email;
        $obj->Subject = $subject;
        //$obj->OnClick = "jQuery(this).attr('href', HideMailto2Email('".self::get_dot_replacer()."', '".$array[0]."', '".$array[1]."', '".Convert::raw2mailto($subject)."')); return true;";

62% of this comment could be valid code. Did you maybe forget this after debugging?

        //TO DO: add a JS function that puts the
        Requirements::javascript(THIRDPARTY_DIR."/jquery/jquery.js");
        //Requirements::javascript("hidemailto/javascript/HideMailto2Email.js");

72% of this comment could be valid code. Did you maybe forget this after debugging?

        return $obj;
    }


    /**
     * encodes a string - randomly
     * @param String $string
     * @return String
     */
    private static function string_encoder($string)
    {
        $encodedString = '';
        $nowCodeString = '';

$nowCodeString is not used, you could remove the assignment.

        $originalLength = strlen($string);
        for ($i = 0; $i < $originalLength; $i++) {
            $encodeMode = rand(1, 2);
            switch ($encodeMode) {
                case 1: // Decimal code
                    $nowCodeString = '&#' . ord($string[$i]) . ';';
                    break;
                case 2: // Hexadecimal code
                    $nowCodeString = '&#x' . dechex(ord($string[$i])) . ';';
                    break;
                default:
                    return 'ERROR: wrong encoding mode.';
            }
            $encodedString .= $nowCodeString;
        }
        return $encodedString;
    }

    public function HideMailToObject()
    {
        if ($email = $this->getHiddenEmailData()) {
            $obj = self::convert_email($email);
            return $obj;
        }
    }

    private function getHiddenEmailData()
    {
        if ($field = self::$email_field) {
            if ($email = $this->owner->$field) {
                return $this->isEmail($email);
            }
        }
    }

    private function isEmail($email)
    {
        if (!preg_match("/^([A-Za-z0-9._-])+\@(([A-Za-z0-9-])+\.)+([A-Za-z0-9])+$/", trim($email))) {
            return "";
        } else {
            return $email;
        }
    }
}

class HideMailto_Role extends DataExtension
{

    //member link

    public function HideMailtoLink()
    {
        return "mailto/" . $this->owner->ID;
    }
}

/**
 * Generates obfusticated links, and also holds the method called when /mailto/
 * is called via the URL. As noted above, take a look at the _config.php file to
 * see how mailto/ maps to this class.
 */
class HideMailto_Controller extends ContentController
{
    /**
     * The list of allowed domains to create a mailto: link to. By default, allow
     * all domains.
     *
     * TODO Maybe the default should be to allow the current domain only?
     */
    private static $allowed_domains = '*';

    public function __construct($dataRecord = null)
    {
        parent::__construct($dataRecord);
        return $this->index();
    }

    public function defaultAction($action)
    {
        return $this->index();
    }

    public $url = '';

    /**
     * This is called by default when this controller is executed.
     */
    public function index()
    {
        $member = null;

$member is not used, you could remove the assignment.

        $user = '';
        $domain = '';
        $subject = '';

$subject is not used, you could remove the assignment.

        // We have two situations to deal with, where urlParams['Action'] is an int (assume Member ID), or a string (assume username)
        if (is_numeric($this->getRequest()->param('Name'))) {
            // Action is numeric, assume it's a member ID and optional ID is the email subject
            $member = Member::get()->byID($this->getRequest()->param('Name'));
            if (!$member) {
                user_error("No member found with ID #" . $this->getRequest()->param('Name'), E_USER_ERROR); // No member found with this ID, perhaps we could redirect a user back instead of giving them a 500 error?
            }
            list($user, $domain) = explode('@', $member->Email);
            $subject = $this->getRequest()->param('ID');
        } else {
            // Action is not numeric, assume that Action is the username, ID is the domain and optional OtherID is the email subject
            $user = urldecode($this->getRequest()->param('Name'));
            $domain = urldecode($this->getRequest()->param('URL'));
            $subject = $this->getRequest()->param('Subject');
        }
        $emailString = "mailto: $user@$domain?subject=".$subject;
        // Make sure the domain is in the allowed domains
        if ((is_string(self::$allowed_domains) && self::$allowed_domains == '*') || in_array($domain, self::$allowed_domains)) {
            // Create the redirect
            header("Location: " . $emailString);
            header("Refresh: 0; url=". $emailString);
            echo $this->customise(array("RedirectBackURL" => $this->RedirectBackURL(), "Email" => $this->makeMailtoString($user, $domain, $subject)))->renderWith("HideMailto");
            $emailString = $this->makeMailtoString($user, $domain, $subject);

$emailString is not used, you could remove the assignment.

        } else {
            user_error("We're not allowed to redirect to the domain '$domain', because it's not listed in the _config.php file", E_USER_ERROR);
        }
    }

    public function RedirectBackURL()
    {
        if (isset($_SERVER['HTTP_REFERER'])) {
            $this->redirectBackURL = $_SERVER['HTTP_REFERER'];
        }
        if (!$this->redirectBackURL) {
            $this->redirectBackURL = Director::absoluteBaseURL();
        }
        return $this->redirectBackURL;
    }


    protected function makeMailtoString($user, $domain, $subject = '')
    {
        $target = 'mailto:' . $user . '@' . $domain;
        if ($subject) {
            $target .= '?subject=' . Convert::raw2mailto($subject);
        }
        $target = str_replace(".", "&x2e;", $target);
        $target = str_replace("@", "&x40;", $target);
        return $target;
    }
}