FbBotApp.php

<?php

namespace pimax;

use pimax\Messages\Message;

class FbBotApp
{
    /**
     * Request type GET
     */
    const TYPE_GET = "get";

    /**
     * Request type POST
     */
    const TYPE_POST = "post";

    /**
     * Request type DELETE
     */
    const TYPE_DELETE = "delete";
    
    /**
     * FB Messenger base API Url
     *
     * @var string
     */
    protected $baseApiUrl = "https://graph.facebook.com/";
    
    /**
     * FB Messenger API version
     *
     * @var string
     */
    protected $apiVersion = "v2.12";

    /**
     * FB Messenger API Url
     *
     * @var null|string must necessarily define in the constructor
     */
    protected $apiUrl = null;

    /**
     * @var null|string
     */
    protected $token = null;

    /**
     * @var null|string
     */
    protected $appsecret_proof = null;

    /**
     * Contains the last cURL error for the current session if encountered
     *
     * @var null|string
     */
    protected $curl_error = null;

    /**
     * FbBotApp constructor.
     * @param string $token
     * @param string $version optional
     * @param string $app_secret optional
     */
    public function __construct($token, $version = null, $app_secret=null)
    {
        $this->token = $token;
        
        if (is_null($version)) {
            $version = $this->apiVersion;
        }
        
        if (!is_null($app_secret)) {
            $this->appsecret_proof = hash_hmac('sha256', $this->token, $app_secret); 
        }
        
        $this->apiUrl = $this->baseApiUrl . $version . "/";
    }

    /**
     * Send Message
     *
     * @param Message $message
     * @return array
     */
     public function send($message)
     {
         return $this->call('me/messages', $message->getData());
     }

     public function batch($messages)
     {
        //Max 50 Requests per batch send
        $max_batch_count = 50;
        $count = 0;
        $data = [];
        $response = [];

        foreach ($messages as $message) {

            $message_data = $message->getData();

            $data['batch'][] = [
              "method"  => "POST",
              "relative_url"  => "me/messages",
              "body" => http_build_query($message_data)
            ];

            $count++;


            if ( $count === $max_batch_count ) {
                $data['batch'] = json_encode($data['batch']);
                $response = array_merge($response, $this->call('/', $data));
                $data['batch'] = [];
                $count = 0;
            }

        }

        //send out last batch
        if ( !empty($data['batch']) ) {
            $data['batch'] = json_encode($data['batch']);
            $response = array_merge($response, $this->call('me/messages', $data));
        }

        return $response;
     }

     public function batchIds($fb_ids, $message)
     {
        //Less resource intensive version

        //Max 50 Requests per batch send
        $max_batch_count = 50;
        $count = 0;
        $data = [];
        $response = [];
        $message_data = $message->getData();

        foreach ($fb_ids as $fb_id) {

            $message_data['recipient']['id'] = $fb_id;

            $data['batch'][] = [
              "method"  => "POST",
              "relative_url"  => "me/messages",
              "body" => http_build_query($message_data)
            ];

            $count++;

            if ( $count === $max_batch_count ) {
                $data['batch'] = json_encode($data['batch']);
                $response = array_merge($response, $this->call('/', $data));
                $data['batch'] = [];
                $count = 0;
            }
        }

        //send out last batch
        if ( !empty($data['batch']) ) {
            $data['batch'] = json_encode($data['batch']);
            $response = array_merge($response, $this->call('me/messages', $data));
        }

        return $response;
     }

     /**
      * Debugging Tool - Can accept an object, array, string, number
      *
      * @param Message $message
      * @return array
      */
     public function debug($fb_id, $message)
     {

          $responses = [];

          $maxlength = 2000;

          $length = strlen(json_encode( $message, JSON_UNESCAPED_SLASHES ) );

          $pages = ceil($length/$maxlength);

          for ($x=0; $x<$pages; $x++) {

              $responses[] = $this->send( new Message($fb_id,substr( json_encode( $message, JSON_UNESCAPED_SLASHES ), $x*$maxlength, $maxlength), false, "ISSUE_RESOLUTION", "REGULAR", "MESSAGE_TAG" ) );

          }

          return $responses;

     }

    /**
     * Upload File (image, audio, video, file)
     *
     * @see Attachment Reuse on https://developers.facebook.com/docs/messenger-platform/send-api-reference
     * @param Messages\Attachment $attachment
     * @return array contains attachment_id (if successfully uploaded).
     */
    public function upload($attachment)
    {
        $data = $attachment->getData();
        $data['attachment']['payload']['is_reusable'] = true;
        return $this->call('me/message_attachments',[
            'message' => $data
        ], self::TYPE_POST);
    }

    /**
     * Get User Profile Info
     *
     * @param int    $id
     * @param string $fields
     * @return UserProfile
     */
    public function userProfile($id, $fields = 'first_name,last_name,profile_pic,locale,timezone,gender')
    {
        return new UserProfile($this->call($id, [
            'fields' => $fields
        ], self::TYPE_GET));
    }

    /**
     * Set Get Started Button
     *
     * @see https://developers.facebook.com/docs/messenger-platform/thread-settings/get-started-button
     * @param string $payload
     * @return array
     */
    public function setGetStartedButton($payload)
    {
        return $this->call('me/messenger_profile', [
            'get_started' => ['payload' => $payload]
        ], self::TYPE_POST);
    }

    /**
     * Delete Get Started Button
     *
     * @see https://developers.facebook.com/docs/messenger-platform/thread-settings/get-started-button
     * @return array
     */
    public function deleteGetStartedButton()
    {
        return $this->call('me/messenger_profile', [
            'fields' => ['get_started'],
        ], self::TYPE_DELETE);
    }


    /**
     * Set Greeting Message
     *
     * @see https://developers.facebook.com/docs/messenger-platform/messenger-profile/greeting-text
     * @param array $localizedGreetings
     * @return array
     */
    public function setGreetingText($localizedGreetings){
        return $this->call('me/messenger_profile', [
            'greeting' => $localizedGreetings
        ], self::TYPE_POST);
    }


    /**
     * Delete Greeting Text
     *
     * @see https://developers.facebook.com/docs/messenger-platform/messenger-profile/greeting-text
     * @return array
     */
    public function deleteGreetingText()
    {
        return $this->call('me/messenger_profile', [
            'fields' => ['greeting'],
        ], self::TYPE_DELETE);
    }

    /**
     * Get Greeting Text
     *
     * @see https://developers.facebook.com/docs/messenger-platform/messenger-profile/greeting-text
     * @return array
     */
    public function getGreetingText(){
        return $this->call('me/messenger_profile', [
            'fields' => 'greeting',
        ], self::TYPE_GET);
    }

    /**
     * Set Target Audience
     *
     * @see https://developers.facebook.com/docs/messenger-platform/messenger-profile/target-audience
     * @param string $audience_type ("all", "custom", "none")
     * @param string $list_type ("whitelist", "blacklist")
     * @param array $countries_array
     * @return array
     */
    public function setTargetAudience($audience_type, $list_type=null, $countries_array=null){

        if ($audience_type === "custom") {
            return $this->call('me/messenger_profile', [
                'target_audience' => [
                    'audience_type' => $audience_type,
                    'countries' => [
                        $list_type => $countries_array
                    ]
               ]
            ], self::TYPE_POST);
        } else {
            return $this->call('me/messenger_profile', [
                'target_audience' => [
                   'audience_type' => $audience_type
               ]
            ], self::TYPE_POST);
        }
    }

    /**
     * Delete Target Audience
     *
     * @see https://developers.facebook.com/docs/messenger-platform/messenger-profile/target-audience
     * @return array
     */
    public function deleteTargetAudience()
    {
        return $this->call('me/messenger_profile', [
            'fields' => ['target_audience'],
        ], self::TYPE_DELETE);
    }

    /**
     * Get Target Audience
     *
     * @see https://developers.facebook.com/docs/messenger-platform/messenger-profile/target-audience
     * @return array
     */
    public function getTargetAudience(){
        return $this->call('me/messenger_profile', [
            'fields' => 'target_audience',
        ], self::TYPE_GET);
    }

    /**
     * Set Domain Whitelisting
     *
     * @see https://developers.facebook.com/docs/messenger-platform/messenger-profile/domain-whitelisting
     * @param array|string $domains
     * @return array
     */
    public function setDomainWhitelist($domains){

        if(!is_array($domains))
            $domains = array($domains);

        return $this->call('me/messenger_profile', [
            'whitelisted_domains' => $domains
        ], self::TYPE_POST);
    }

    /**
     * Delete Domain Whitelisting
     *
     * @see https://developers.facebook.com/docs/messenger-platform/messenger-profile/domain-whitelisting
     * @return array
     */
    public function deleteDomainWhitelist()
    {
        return $this->call('me/messenger_profile', [
            'fields' => ['whitelisted_domains'],
        ], self::TYPE_DELETE);
    }

    /**
     * Get Domain Whitelisting
     *
     * @see https://developers.facebook.com/docs/messenger-platform/messenger-profile/domain-whitelisting
     * @return array
     */
    public function getDomainWhitelist(){
        return $this->call('me/messenger_profile', [
            'fields' => 'whitelisted_domains',
        ], self::TYPE_GET);
    }

    /**
     * Set Chat Extension Home URL
     *
     * @see https://developers.facebook.com/docs/messenger-platform/messenger-profile/home-url/
     * @param string  $url
     * @param string  $webview_height_ratio
     * @param string  $webview_share_button
     * @param boolean $in_test
     * @return array
     */
    public function setHomeUrl($url, $webview_height_ratio = 'tall', $webview_share_button = 'hide', $in_test = false){
        return $this->call('me/messenger_profile', [
            'home_url' => [
                'url' => $url,
                'webview_height_ratio' => $webview_height_ratio,
                'webview_share_button' => $webview_share_button,
                'in_test' => $in_test
            ]
        ], self::TYPE_POST);
    }

    /**
     * Delete Chat Extension Home Url
     *
     * @see https://developers.facebook.com/docs/messenger-platform/messenger-profile/home-url/
     * @return array
     */
    public function deleteHomeUrl()
    {
        return $this->call('me/messenger_profile', [
            'fields' => ['home_url'],
        ], self::TYPE_DELETE);
    }

    /**
     * Get Chat Extension Home Url
     *
     * @see https://developers.facebook.com/docs/messenger-platform/messenger-profile/home-url/
     * @return array
     */
    public function getHomeUrl(){
        return $this->call('me/messenger_profile', [
            'fields' => 'home_url',
        ], self::TYPE_GET);
    }

    /**
     * Set Nested Menu
     *
     * @see https://developers.facebook.com/docs/messenger-platform/messenger-profile/persistent-menu
     * @params $localizedMenu
     * @return array
     */
    public function setPersistentMenu($localizedMenu)
    {
        $elements = [];

        foreach ($localizedMenu as $menu) {
            $elements[] = $menu->getData();
        }

        return $this->call('me/messenger_profile', [
            'persistent_menu' => $elements
        ], self::TYPE_POST);
    }
    
    /**
     * Get Nested Menu
     *
     * @see https://developers.facebook.com/docs/messenger-platform/messenger-profile/persistent-menu
     * @return array
     */
    public function getPersistentMenu()
    {
        return $this->call('me/messenger_profile', [
            'fields' => 'persistent_menu',
        ], self::TYPE_GET);
    }

    /**
     * Remove Persistent Menu
     *
     * @see https://developers.facebook.com/docs/messenger-platform/messenger-profile/persistent-menu
     * @return array
     */
    public function deletePersistentMenu()
    {
        return $this->call('me/messenger_profile', [
            'fields' => ['persistent_menu'],
        ], self::TYPE_DELETE);
    }


    /**
     * Set NLP Settings
     *
     * @see https://developers.facebook.com/docs/messenger-platform/built-in-nlp
     * @return array
     */
    public function setNLP($nlp_enabled = true, $model = 'ENGLISH', $custom_token = null, $verbose = false, $n_best = 1){
        return $this->call('me/nlp_configs', [
            'nlp_enabled' => $nlp_enabled,
            'model' => $model,
            'custom_token' => $custom_token,
            'verbose' => $verbose,
            'n_best' => $n_best
        ], self::TYPE_POST);
    }


    /**
     * Messaging Insights API
     * Metrics = page_messages_active_threads_unique, page_messages_blocked_conversations_unique, page_messages_reported_conversations_unique
     *           page_messages_reported_conversations_by_report_type_unique, page_messages_feedback_by_action_unique,
     *
     * @see https://developers.facebook.com/docs/messenger-platform/analytics#insights
     * @return array
     */
    public function getInsights($metric = 'page_messages_active_threads_unique'){
        return $this->call('me/insights', [
            'metric' => $metric
        ], self::TYPE_GET);
    }

    /**
     * Request to API
     *
     * @access public
     * @param string $url
     * @param array  $data
     * @param string $type Type of request (GET|POST|DELETE)
     * @return array
     */
    public function call($url, $data, $type = self::TYPE_POST)
    {
        $data['access_token'] = $this->token;

        if (!is_null($this->appsecret_proof)){
            $data['appsecret_proof'] = $this->appsecret_proof;
        }
        
        $headers = [
            'Content-Type: application/json',
        ];

        if ($type == self::TYPE_GET) {
            $url .= '?'.http_build_query($data);
        }

        $process = curl_init($this->apiUrl.$url);
        curl_setopt($process, CURLOPT_HTTPHEADER, $headers);
        curl_setopt($process, CURLOPT_HEADER, false);
        curl_setopt($process, CURLOPT_TIMEOUT, 30);

        if($type == self::TYPE_POST || $type == self::TYPE_DELETE) {
            curl_setopt($process, CURLOPT_POST, 1);
            curl_setopt($process, CURLOPT_POSTFIELDS, json_encode($data));
        }

        if ($type == self::TYPE_DELETE) {
            curl_setopt($process, CURLOPT_CUSTOMREQUEST, "DELETE");
        }

        curl_setopt($process, CURLOPT_RETURNTRANSFER, true);
        $return = curl_exec($process);

        /**
         * Check for cURL Errors and, if found display the error code
         *
         * @see http://php.net/manual/en/function.curl-error.php
         */
        $curl_error = curl_error($process);
        if ($curl_error) {
            $this->curl_error = $curl_error;
        }

        curl_close($process);

        return json_decode($return, true);
    }

    /**
     * Get the last cURL error if encountered
     *
     * @return null|string
     */
    public function getCurlError()
    {
        return $this->curl_error;
    }
}