CAS/CAS/Request/CurlMultiRequest.php

   1 <?php
   2
   3 /**
   4  * Licensed to Jasig under one or more contributor license
   5  * agreements. See the NOTICE file distributed with this work for
   6  * additional information regarding copyright ownership.
   7  *
   8  * Jasig licenses this file to you under the Apache License,
   9  * Version 2.0 (the "License"); you may not use this file except in
  10  * compliance with the License. You may obtain a copy of the License at:
  11  *
  12  * http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  *
  20  * PHP Version 5
  21  *
  22  * @file     CAS/Request/AbstractRequest.php
  23  * @category Authentication
  24  * @package  PhpCAS
  25  * @author   Adam Franco <afranco@middlebury.edu>
  26  * @license  http://www.apache.org/licenses/LICENSE-2.0  Apache License 2.0
  27  * @link     https://wiki.jasig.org/display/CASC/phpCAS
  28  */
  29
  30 /**
  31  * This interface defines a class library for performing multiple web requests
  32  * in batches. Implementations of this interface may perform requests serially
  33  * or in parallel.
  34  *
  35  * @class    CAS_Request_CurlMultiRequest
  36  * @category Authentication
  37  * @package  PhpCAS
  38  * @author   Adam Franco <afranco@middlebury.edu>
  39  * @license  http://www.apache.org/licenses/LICENSE-2.0  Apache License 2.0
  40  * @link     https://wiki.jasig.org/display/CASC/phpCAS
  41  */
  42 class CAS_Request_CurlMultiRequest
  43 implements CAS_Request_MultiRequestInterface
  44 {
  45     private $_requests = array();
  46     private $_sent = false;
  47
  48     /*********************************************************
  49      * Add Requests
  50     *********************************************************/
  51
  52     /**
  53      * Add a new Request to this batch.
  54      * Note, implementations will likely restrict requests to their own concrete
  55      * class hierarchy.
  56      *
  57      * @param CAS_Request_RequestInterface $request reqest to add
  58      *
  59      * @return void
  60      * @throws CAS_OutOfSequenceException If called after the Request has been sent.
  61      * @throws CAS_InvalidArgumentException If passed a Request of the wrong
  62      * implmentation.
  63      */
  64     public function addRequest (CAS_Request_RequestInterface $request)
  65     {
  66         if ($this->_sent) {
  67             throw new CAS_OutOfSequenceException('Request has already been sent cannot '.__METHOD__);
  68         }
  69         if (!$request instanceof CAS_Request_CurlRequest) {
  70             throw new CAS_InvalidArgumentException('As a CAS_Request_CurlMultiRequest, I can only work with CAS_Request_CurlRequest objects.');
  71         }
  72
  73         $this->_requests[] = $request;
  74     }
  75
  76     /**
  77      * Retrieve the number of requests added to this batch.
  78      *
  79      * @return number of request elements
  80      */
  81     public function getNumRequests()
  82     {
  83         if ($this->_sent) {
  84             throw new CAS_OutOfSequenceException('Request has already been sent cannot '.__METHOD__);
  85         }
  86         return count($this->_requests);
  87     }
  88
  89     /*********************************************************
  90      * 2. Send the Request
  91     *********************************************************/
  92
  93     /**
  94      * Perform the request. After sending, all requests will have their
  95      * responses poulated.
  96      *
  97      * @return bool TRUE on success, FALSE on failure.
  98      * @throws CAS_OutOfSequenceException If called multiple times.
  99      */
 100     public function send ()
 101     {
 102         if ($this->_sent) {
 103             throw new CAS_OutOfSequenceException('Request has already been sent cannot send again.');
 104         }
 105         if (!count($this->_requests)) {
 106             throw new CAS_OutOfSequenceException('At least one request must be added via addRequest() before the multi-request can be sent.');
 107         }
 108
 109         $this->_sent = true;
 110
 111         // Initialize our handles and configure all requests.
 112         $handles = array();
 113         $multiHandle = curl_multi_init();
 114         foreach ($this->_requests as $i => $request) {
 115             $handle = $request->_initAndConfigure();
 116             curl_setopt($handle, CURLOPT_RETURNTRANSFER, true);
 117             $handles[$i] = $handle;
 118             curl_multi_add_handle($multiHandle, $handle);
 119         }
 120
 121         // Execute the requests in parallel.
 122         do {
 123             curl_multi_exec($multiHandle, $running);
 124         } while ($running > 0);
 125
 126         // Populate all of the responses or errors back into the request objects.
 127         foreach ($this->_requests as $i => $request) {
 128             $buf = curl_multi_getcontent($handles[$i]);
 129             $request->_storeResponseBody($buf);
 130             curl_multi_remove_handle($multiHandle, $handles[$i]);
 131             curl_close($handles[$i]);
 132         }
 133
 134         curl_multi_close($multiHandle);
 135     }
 136 }