<?php

class SMSNotifier_BulkGate_Provider implements SMSNotifier_ISMSProvider_Model 
{
    /** @var string */
    private $username;

    /** @var string */
    private $password;

    /** @var array */
    private $parameters = array();

    const SERVICE_URI = 'https://portal.bulkgate.com/api/1.0/simple';

    private static $REQUIRED_PARAMETERS = array(
        array('name' => 'username', 'label' => 'Application ID', 'type' => 'text'),
        array('name' => 'password', 'label' => 'Application token', 'type' => 'text'),
        array('name' => 'sender_id',
            'label' => 'Sender ID',
            'type' => 'picklist',
            'picklistvalues' => array(
                'gSystem' => 'System number',
                'gShort' => 'Short Code',
                'gText' => 'Text sender'
            )),
        array('name' => 'sender_id_value', 'label' => 'Sender value', 'type' => 'text'),
        array('name' => 'unicode', 'label' => 'Character Set', 'type' => 'picklist', 'picklistvalues' => array('1' => 'Unicode', '0' => '7bit')),
        array('name' => 'country', 'label' => 'Country', 'type' => 'picklist', 'picklistvalues' => array(
            '' => '-',
            'AF' => 'Afghanistan',
            'AX' => 'Aland Islands',
            'AL' => 'Albania',
            'DZ' => 'Algeria',
            'AS' => 'American Samoa',
            'AD' => 'Andorra',
            'AO' => 'Angola',
            'AI' => 'Anguilla',
            'AQ' => 'Antarctica',
            'AG' => 'Antigua And Barbuda',
            'AR' => 'Argentina',
            'AM' => 'Armenia',
            'AW' => 'Aruba',
            'AU' => 'Australia',
            'AT' => 'Austria',
            'AZ' => 'Azerbaijan',
            'BS' => 'Bahamas',
            'BH' => 'Bahrain',
            'BD' => 'Bangladesh',
            'BB' => 'Barbados',
            'BY' => 'Belarus',
            'BE' => 'Belgium',
            'BZ' => 'Belize',
            'BJ' => 'Benin',
            'BM' => 'Bermuda',
            'BT' => 'Bhutan',
            'BO' => 'Bolivia',
            'BA' => 'Bosnia And Herzegovina',
            'BW' => 'Botswana',
            'BV' => 'Bouvet Island',
            'BR' => 'Brazil',
            'IO' => 'British Indian Ocean Territory',
            'BN' => 'Brunei Darussalam',
            'BG' => 'Bulgaria',
            'BF' => 'Burkina Faso',
            'BI' => 'Burundi',
            'KH' => 'Cambodia',
            'CM' => 'Cameroon',
            'CA' => 'Canada',
            'CV' => 'Cape Verde',
            'KY' => 'Cayman Islands',
            'CF' => 'Central African Republic',
            'TD' => 'Chad',
            'CL' => 'Chile',
            'CN' => 'China',
            'CX' => 'Christmas Island',
            'CC' => 'Cocos (Keeling) Islands',
            'CO' => 'Colombia',
            'KM' => 'Comoros',
            'CG' => 'Congo',
            'CD' => 'Congo, Democratic Republic',
            'CK' => 'Cook Islands',
            'CR' => 'Costa Rica',
            'CI' => 'Cote D\'Ivoire',
            'HR' => 'Croatia',
            'CU' => 'Cuba',
            'CY' => 'Cyprus',
            'CZ' => 'Czech Republic',
            'DK' => 'Denmark',
            'DJ' => 'Djibouti',
            'DM' => 'Dominica',
            'DO' => 'Dominican Republic',
            'EC' => 'Ecuador',
            'EG' => 'Egypt',
            'SV' => 'El Salvador',
            'GQ' => 'Equatorial Guinea',
            'ER' => 'Eritrea',
            'EE' => 'Estonia',
            'ET' => 'Ethiopia',
            'FK' => 'Falkland Islands (Malvinas)',
            'FO' => 'Faroe Islands',
            'FJ' => 'Fiji',
            'FI' => 'Finland',
            'FR' => 'France',
            'GF' => 'French Guiana',
            'PF' => 'French Polynesia',
            'TF' => 'French Southern Territories',
            'GA' => 'Gabon',
            'GM' => 'Gambia',
            'GE' => 'Georgia',
            'DE' => 'Germany',
            'GH' => 'Ghana',
            'GI' => 'Gibraltar',
            'GR' => 'Greece',
            'GL' => 'Greenland',
            'GD' => 'Grenada',
            'GP' => 'Guadeloupe',
            'GU' => 'Guam',
            'GT' => 'Guatemala',
            'GG' => 'Guernsey',
            'GN' => 'Guinea',
            'GW' => 'Guinea-Bissau',
            'GY' => 'Guyana',
            'HT' => 'Haiti',
            'HM' => 'Heard Island & Mcdonald Islands',
            'VA' => 'Holy See (Vatican City State)',
            'HN' => 'Honduras',
            'HK' => 'Hong Kong',
            'HU' => 'Hungary',
            'IS' => 'Iceland',
            'IN' => 'India',
            'ID' => 'Indonesia',
            'IR' => 'Iran, Islamic Republic Of',
            'IQ' => 'Iraq',
            'IE' => 'Ireland',
            'IM' => 'Isle Of Man',
            'IL' => 'Israel',
            'IT' => 'Italy',
            'JM' => 'Jamaica',
            'JP' => 'Japan',
            'JE' => 'Jersey',
            'JO' => 'Jordan',
            'KZ' => 'Kazakhstan',
            'KE' => 'Kenya',
            'KI' => 'Kiribati',
            'KR' => 'Korea',
            'KW' => 'Kuwait',
            'KG' => 'Kyrgyzstan',
            'LA' => 'Lao People\'s Democratic Republic',
            'LV' => 'Latvia',
            'LB' => 'Lebanon',
            'LS' => 'Lesotho',
            'LR' => 'Liberia',
            'LY' => 'Libyan Arab Jamahiriya',
            'LI' => 'Liechtenstein',
            'LT' => 'Lithuania',
            'LU' => 'Luxembourg',
            'MO' => 'Macao',
            'MK' => 'Macedonia',
            'MG' => 'Madagascar',
            'MW' => 'Malawi',
            'MY' => 'Malaysia',
            'MV' => 'Maldives',
            'ML' => 'Mali',
            'MT' => 'Malta',
            'MH' => 'Marshall Islands',
            'MQ' => 'Martinique',
            'MR' => 'Mauritania',
            'MU' => 'Mauritius',
            'YT' => 'Mayotte',
            'MX' => 'Mexico',
            'FM' => 'Micronesia, Federated States Of',
            'MD' => 'Moldova',
            'MC' => 'Monaco',
            'MN' => 'Mongolia',
            'ME' => 'Montenegro',
            'MS' => 'Montserrat',
            'MA' => 'Morocco',
            'MZ' => 'Mozambique',
            'MM' => 'Myanmar',
            'NA' => 'Namibia',
            'NR' => 'Nauru',
            'NP' => 'Nepal',
            'NL' => 'Netherlands',
            'AN' => 'Netherlands Antilles',
            'NC' => 'New Caledonia',
            'NZ' => 'New Zealand',
            'NI' => 'Nicaragua',
            'NE' => 'Niger',
            'NG' => 'Nigeria',
            'NU' => 'Niue',
            'NF' => 'Norfolk Island',
            'MP' => 'Northern Mariana Islands',
            'NO' => 'Norway',
            'OM' => 'Oman',
            'PK' => 'Pakistan',
            'PW' => 'Palau',
            'PS' => 'Palestinian Territory, Occupied',
            'PA' => 'Panama',
            'PG' => 'Papua New Guinea',
            'PY' => 'Paraguay',
            'PE' => 'Peru',
            'PH' => 'Philippines',
            'PN' => 'Pitcairn',
            'PL' => 'Poland',
            'PT' => 'Portugal',
            'PR' => 'Puerto Rico',
            'QA' => 'Qatar',
            'RE' => 'Reunion',
            'RO' => 'Romania',
            'RU' => 'Russian Federation',
            'RW' => 'Rwanda',
            'BL' => 'Saint Barthelemy',
            'SH' => 'Saint Helena',
            'KN' => 'Saint Kitts And Nevis',
            'LC' => 'Saint Lucia',
            'MF' => 'Saint Martin',
            'PM' => 'Saint Pierre And Miquelon',
            'VC' => 'Saint Vincent And Grenadines',
            'WS' => 'Samoa',
            'SM' => 'San Marino',
            'ST' => 'Sao Tome And Principe',
            'SA' => 'Saudi Arabia',
            'SN' => 'Senegal',
            'RS' => 'Serbia',
            'SC' => 'Seychelles',
            'SL' => 'Sierra Leone',
            'SG' => 'Singapore',
            'SK' => 'Slovakia',
            'SI' => 'Slovenia',
            'SB' => 'Solomon Islands',
            'SO' => 'Somalia',
            'ZA' => 'South Africa',
            'GS' => 'South Georgia And Sandwich Isl.',
            'ES' => 'Spain',
            'LK' => 'Sri Lanka',
            'SD' => 'Sudan',
            'SR' => 'Suriname',
            'SJ' => 'Svalbard And Jan Mayen',
            'SZ' => 'Swaziland',
            'SE' => 'Sweden',
            'CH' => 'Switzerland',
            'SY' => 'Syrian Arab Republic',
            'TW' => 'Taiwan',
            'TJ' => 'Tajikistan',
            'TZ' => 'Tanzania',
            'TH' => 'Thailand',
            'TL' => 'Timor-Leste',
            'TG' => 'Togo',
            'TK' => 'Tokelau',
            'TO' => 'Tonga',
            'TT' => 'Trinidad And Tobago',
            'TN' => 'Tunisia',
            'TR' => 'Turkey',
            'TM' => 'Turkmenistan',
            'TC' => 'Turks And Caicos Islands',
            'TV' => 'Tuvalu',
            'UG' => 'Uganda',
            'UA' => 'Ukraine',
            'AE' => 'United Arab Emirates',
            'GB' => 'United Kingdom',
            'US' => 'United States',
            'UM' => 'United States Outlying Islands',
            'UY' => 'Uruguay',
            'UZ' => 'Uzbekistan',
            'VU' => 'Vanuatu',
            'VE' => 'Venezuela',
            'VN' => 'Viet Nam',
            'VG' => 'Virgin Islands, British',
            'VI' => 'Virgin Islands, U.S.',
            'WF' => 'Wallis And Futuna',
            'EH' => 'Western Sahara',
            'YE' => 'Yemen',
            'ZM' => 'Zambia',
            'ZW' => 'Zimbabwe')),
    );

    public function getName() 
    {
        return 'BulkGate';
    }

    public function setAuthParameters($username, $password) 
    {
        $this->username = $username;
        $this->password = $password;
    }

    public function setParameter($key, $value) 
    {
        $this->parameters[$key] = $value;
    }

    public function getParameter($key, $value = null)
    {
        if (isset($this->parameters[$key])) 
        {
            return $this->parameters[$key];
        }
        return $value;
    }

    public function getRequiredParams() 
    {
        return self::$REQUIRED_PARAMETERS;
    }

    public function getServiceURL($type = false) 
    {
        if ($type)
        {
            switch (strtoupper($type)) 
            {
                case self::SERVICE_SEND:
                    return self::SERVICE_URI.'/promotional/';
                break;
                case self::SERVICE_QUERY:
                    return self::SERVICE_URI . '/delivery/';
                break;
            }
        }
        return false;
    }

    protected function prepareParameters() 
    {
	    $params = array();

        foreach (self::$REQUIRED_PARAMETERS as $requiredParam)
        {
            $paramName = $requiredParam['name'];
            $params[$paramName] = $this->getParameter($paramName);
        }
        return $params;
    }

    public function send($message, $toNumbers)
    {
        if (!is_array($toNumbers))
        {
            $toNumbers = array($toNumbers);
        }

        $params = $this->prepareParameters();
        $params['text'] = $message;
        $params['number'] = implode(';', $toNumbers);

        $httpClient = new Vtiger_Net_Client(
            $this->getServiceURL(self::SERVICE_SEND)
        );

        $response = $httpClient->doPost(array(
            'application_id' => $params['username'],
            'application_token' => $params['password'],
            'unicode' => $params['unicode'],
            'number' => $params['number'],
            'text' => $params['text'],
            'sender_id' => $params['sender_id'],
            'sender_id_value' => $params['sender_id_value'],
            'country' => strtolower($params['country']),
        ));

        $rows = json_decode($response, true);
        $numbers = explode(';', $params['number']);
        $results = array();

        if(isset($rows['error']))
        {
            foreach ($numbers as $number)
            {
                $results[] = array(
                    'to' => $number,
                    'error' => true,
                    'statusmessage' => $rows['error'],
                    'status' => self::MSG_STATUS_ERROR
                );
            }
        }
        else if(isset($rows['data']) && isset($rows['data']['response']))
        {
            foreach ($rows['data']['response'] as $value)
            {
                $value = (array) $value;
                $status = isset($value['status']) ? $value['status'] : 'error';

                $results[] = array(
                    'error' => $status === 'error',
                    'to' => isset($value['number']) ? $value['number'] : '',
                    'id' => isset($value['sms_id']) ? $value['sms_id'] : '-',
                    'statusmessage' => isset($value['error']) ? $value['error'] : $status,
                    'status' => $this->checkStatus($status)
                );
            }
        }
        return $results;
    }

    public function checkStatus($status)
    {
        if ($status === 'sent')
        {
            return self::MSG_STATUS_DISPATCHED;
        } 
        elseif ($status === 'accepted')
        {
            return self::MSG_STATUS_DELIVERED;
        }
        elseif ($status === 'scheduled')
        {
            return self::MSG_STATUS_PROCESSING;
        }
        elseif($status === 'error')
        {
            return self::MSG_STATUS_ERROR;
        }
        return self::MSG_STATUS_FAILED;
    }

    public function checkQueryStatus($status)
    {
        switch($status)
        {
            case '1':
                return self::MSG_STATUS_DELIVERED;
            break;
            case '2':
                return self::MSG_STATUS_PROCESSING;
            break;
            case '3':
            case '8':
                return self::MSG_STATUS_FAILED;
            break;
            case '6':
                return self::MSG_STATUS_DELIVERED;
            break;
        }
        return '';
    }

    public function query($messageId)
    {
        $params = $this->prepareParameters();
        $serviceURL = $this->getServiceURL(self::SERVICE_QUERY);
        $httpClient = new Vtiger_Net_Client($serviceURL);

        $response = $httpClient->doPost(array(
            'application_id' => $params['username'],
            'application_token' => $params['password'],
            'sms_id' => $messageId,
        ));

        $rows = json_decode($response, true);
        $result = array();

        if(isset($rows['error']))
        {
            $result = array(
                'error' => true,
                'status' => self::MSG_STATUS_DISPATCHED,
                'needlookup' => 1,
                'statusmessage' => $rows['error']
            );
        }
        else if(isset($rows['data']))
        {
            $result = array(
                'error' => false,
                'status' => isset($rows['data']['status']) ? $this->checkQueryStatus($rows['data']['status']) : '',
                'needlookup' => 0,
                'statusmessage' => isset($rows['data']['message']) ? $rows['data']['message'] : ''
            );
        }
        return $result;
    }

    function getProviderEditFieldTemplateName() 
    {
        return 'BaseProviderEditFields.tpl';
    }
}