1 | <?php |
---|
2 | /** |
---|
3 | * Copyright 2011 Bas de Nooijer. All rights reserved. |
---|
4 | * |
---|
5 | * Redistribution and use in source and binary forms, with or without |
---|
6 | * modification, are permitted provided that the following conditions are met: |
---|
7 | * |
---|
8 | * 1. Redistributions of source code must retain the above copyright notice, |
---|
9 | * this list of conditions and the following disclaimer. |
---|
10 | * |
---|
11 | * 2. Redistributions in binary form must reproduce the above copyright notice, |
---|
12 | * this listof conditions and the following disclaimer in the documentation |
---|
13 | * and/or other materials provided with the distribution. |
---|
14 | * |
---|
15 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS" |
---|
16 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
---|
17 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
---|
18 | * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE |
---|
19 | * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
---|
20 | * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
---|
21 | * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
---|
22 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
---|
23 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
---|
24 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
---|
25 | * POSSIBILITY OF SUCH DAMAGE. |
---|
26 | * |
---|
27 | * The views and conclusions contained in the software and documentation are |
---|
28 | * those of the authors and should not be interpreted as representing official |
---|
29 | * policies, either expressed or implied, of the copyright holder. |
---|
30 | * |
---|
31 | * @copyright Copyright 2011 Bas de Nooijer <solarium@raspberry.nl> |
---|
32 | * @license http://github.com/basdenooijer/solarium/raw/master/COPYING |
---|
33 | * @link http://www.solarium-project.org/ |
---|
34 | * |
---|
35 | * @package Solarium |
---|
36 | */ |
---|
37 | |
---|
38 | /** |
---|
39 | * PostBigRequest plugin |
---|
40 | * |
---|
41 | * If you reach the url/header length limit of your servlet container your queries will fail. |
---|
42 | * You can increase the limit in the servlet container, but if that's not possible this plugin can automatically |
---|
43 | * convert big GET requests into POST requests. A POST request (usually) has a much higher limit. |
---|
44 | * |
---|
45 | * The default maximum querystring length is 1024. This doesn't include the base url or headers. |
---|
46 | * For most servlet setups this limit leaves enough room for that extra data. Adjust the limit if needed. |
---|
47 | * |
---|
48 | * @package Solarium |
---|
49 | * @subpackage Plugin |
---|
50 | */ |
---|
51 | class Solarium_Plugin_PostBigRequest extends Solarium_Plugin_Abstract |
---|
52 | { |
---|
53 | |
---|
54 | /** |
---|
55 | * Default options |
---|
56 | * |
---|
57 | * @var array |
---|
58 | */ |
---|
59 | protected $_options = array( |
---|
60 | 'maxquerystringlength' => 1024, |
---|
61 | ); |
---|
62 | |
---|
63 | /** |
---|
64 | * Set maxquerystringlength enabled option |
---|
65 | * |
---|
66 | * @param integer $value |
---|
67 | * @return self Provides fluent interface |
---|
68 | */ |
---|
69 | public function setMaxQueryStringLength($value) |
---|
70 | { |
---|
71 | return $this->_setOption('maxquerystringlength', $value); |
---|
72 | } |
---|
73 | |
---|
74 | /** |
---|
75 | * Get maxquerystringlength option |
---|
76 | * |
---|
77 | * @return integer |
---|
78 | */ |
---|
79 | public function getMaxQueryStringLength() |
---|
80 | { |
---|
81 | return $this->getOption('maxquerystringlength'); |
---|
82 | } |
---|
83 | |
---|
84 | /** |
---|
85 | * Event hook to adjust client settings just before query execution |
---|
86 | * |
---|
87 | * @param Solarium_Query $query |
---|
88 | * @param Solarium_Client_Request $request |
---|
89 | * @return void |
---|
90 | */ |
---|
91 | public function postCreateRequest($query, $request) |
---|
92 | { |
---|
93 | $queryString = $request->getQueryString(); |
---|
94 | if ($request->getMethod() == Solarium_Client_Request::METHOD_GET && |
---|
95 | strlen($queryString) > $this->getMaxQueryStringLength()) { |
---|
96 | |
---|
97 | $request->setMethod(Solarium_Client_Request::METHOD_POST); |
---|
98 | $request->setRawData($queryString); |
---|
99 | $request->clearParams(); |
---|
100 | $request->addHeader('Content-Type: application/x-www-form-urlencoded'); |
---|
101 | } |
---|
102 | } |
---|
103 | |
---|
104 | } |
---|