├── src └── Damas │ └── PaytabsBundle │ ├── DamasPaytabsBundle.php │ ├── DependencyInjection │ ├── Configuration.php │ └── DamasPaytabsExtension.php │ └── Util │ └── Paytabs.php ├── composer.json ├── README.md ├── Example └── DefaultController.php └── LICENSE.TXT /src/Damas/PaytabsBundle/DamasPaytabsBundle.php: -------------------------------------------------------------------------------- 1 | root('damas_paytabs'); 22 | 23 | // Here you should define the parameters that are allowed to 24 | // configure your bundle. See the documentation linked above for 25 | // more information on that topic. 26 | 27 | return $treeBuilder; 28 | } 29 | } 30 | -------------------------------------------------------------------------------- /src/Damas/PaytabsBundle/DependencyInjection/DamasPaytabsExtension.php: -------------------------------------------------------------------------------- 1 | processConfiguration($configuration, $configs); 24 | 25 | //$loader = new Loader\YamlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config')); 26 | //$loader->load('services.yml'); 27 | } 28 | } 29 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Paytabs Symfony 2 | 3 | ## Installation 4 | Begin by installing this package through Composer. Just run following command to terminal- 5 | 6 | ```php 7 | composer require maq89/paytabs-symfony 8 | ``` 9 | 10 | Enable the bundle in the kernel, goto app/AppKernel.php 11 | ```php 12 | $bundles = array( 13 | // ... 14 | new Damas\PaytabsBundle\DamasPaytabsBundle(), 15 | // ... 16 | ); 17 | ``` 18 | 19 | Use Namespace 20 | ```php 21 | use Damas\PaytabsBundle\Util\Paytabs; 22 | ``` 23 | 24 | ## Example: 25 | ### Create Payment Page: 26 | ```php 27 | $pt = Paytabs::getInstance("MERCHANT_EMAIL", "SECRET_KEY"); 28 | $result = $pt->create_pay_page(array( 29 | "merchant_email" => "MERCHANT_EMAIL", 30 | 'secret_key' => "SECRET_KEY", 31 | 'title' => "John Doe", 32 | 'cc_first_name' => "John", 33 | 'cc_last_name' => "Doe", 34 | 'email' => "customer@email.com", 35 | 'cc_phone_number' => "973", 36 | 'phone_number' => "33333333", 37 | 'billing_address' => "Juffair, Manama, Bahrain", 38 | 'city' => "Manama", 39 | 'state' => "Capital", 40 | 'postal_code' => "97300", 41 | 'country' => "BHR", 42 | 'address_shipping' => "Juffair, Manama, Bahrain", 43 | 'city_shipping' => "Manama", 44 | 'state_shipping' => "Capital", 45 | 'postal_code_shipping' => "97300", 46 | 'country_shipping' => "BHR", 47 | "products_per_title"=> "Mobile Phone", 48 | 'currency' => "BHD", 49 | "unit_price"=> "10", 50 | 'quantity' => "1", 51 | 'other_charges' => "0", 52 | 'amount' => "10.00", 53 | 'discount'=>"0", 54 | "msg_lang" => "english", 55 | "reference_no" => "1231231", 56 | "site_url" => "https://your-site.com", 57 | 'return_url' => "http://127.0.0.1:8000/paytabs-response", 58 | "cms_with_version" => "API USING PHP" 59 | )); 60 | 61 | 62 | if($result->response_code == 4012){ 63 | return $this->redirect($result->payment_url); 64 | } 65 | else{ 66 | throw new \Exception($result->result); 67 | } 68 | ``` 69 | ### Verify Payment: 70 | ```php 71 | $pt = Paytabs::getInstance("MERCHANT_EMAIL", "SECRET_KEY"); 72 | $result = $pt->verify_payment($request->request->get('payment_reference')); 73 | if($result->response_code == 100){ 74 | // Payment Success 75 | } 76 | else{ 77 | throw new \Exception($result->result); 78 | } 79 | 80 | ``` 81 | -------------------------------------------------------------------------------- /Example/DefaultController.php: -------------------------------------------------------------------------------- 1 | create_pay_page(array( 21 | "merchant_email" => "MERCHANT_EMAIL", 22 | 'secret_key' => "SECRET_KEY", 23 | 'title' => "John Doe", 24 | 'cc_first_name' => "John", 25 | 'cc_last_name' => "Doe", 26 | 'email' => "customer@email.com", 27 | 'cc_phone_number' => "973", 28 | 'phone_number' => "33333333", 29 | 'billing_address' => "Juffair, Manama, Bahrain", 30 | 'city' => "Manama", 31 | 'state' => "Capital", 32 | 'postal_code' => "97300", 33 | 'country' => "BHR", 34 | 'address_shipping' => "Juffair, Manama, Bahrain", 35 | 'city_shipping' => "Manama", 36 | 'state_shipping' => "Capital", 37 | 'postal_code_shipping' => "97300", 38 | 'country_shipping' => "BHR", 39 | "products_per_title"=> "Mobile Phone", 40 | 'currency' => "BHD", 41 | "unit_price"=> "10", 42 | 'quantity' => "1", 43 | 'other_charges' => "0", 44 | 'amount' => "10.00", 45 | 'discount'=>"0", 46 | "msg_lang" => "english", 47 | "reference_no" => "1231231", 48 | "site_url" => "https://your-site.com", 49 | 'return_url' => "http://127.0.0.1:8000/paytabs-response", 50 | "cms_with_version" => "API USING PHP" 51 | )); 52 | 53 | 54 | if($result->response_code == 4012){ 55 | return $this->redirect($result->payment_url); 56 | } 57 | else{ 58 | throw new \Exception($result->result); 59 | } 60 | 61 | return new Response(); 62 | } 63 | 64 | /** 65 | * @Route("/paytabs-response") 66 | */ 67 | public function responseAction(Request $request) 68 | { 69 | $pt = Paytabs::getInstance("MERCHANT_EMAIL", "SECRET_KEY"); 70 | $result = $pt->verify_payment($request->request->get('payment_reference')); 71 | if($result->response_code == 100){ 72 | // Payment Success 73 | } 74 | else{ 75 | throw new \Exception($result->result); 76 | } 77 | 78 | return new Response(); 79 | } 80 | } 81 | -------------------------------------------------------------------------------- /src/Damas/PaytabsBundle/Util/Paytabs.php: -------------------------------------------------------------------------------- 1 | setMerchant($merchant_email, $merchant_secretKey); 18 | return $inst; 19 | } 20 | function setMerchant($merchant_email, $merchant_secretKey) { 21 | $this->merchant_email = $merchant_email; 22 | $this->merchant_secretKey = $merchant_secretKey; 23 | $this->api_key = ""; 24 | } 25 | function authentication(){ 26 | $obj = json_decode($this->runPost(AUTHENTICATION, array("merchant_email"=> $this->merchant_email, "merchant_secretKey"=> $this->merchant_secretKey))); 27 | if($obj->access == "granted") 28 | $this->api_key = $obj->api_key; 29 | else 30 | $this->api_key = ""; 31 | return $this->api_key; 32 | } 33 | function create_pay_page($values) { 34 | $values['merchant_email'] = $this->merchant_email; 35 | $values['merchant_secretKey'] = $this->merchant_secretKey; 36 | $values['ip_customer'] = $_SERVER['REMOTE_ADDR']; 37 | $values['ip_merchant'] = isset($_SERVER['SERVER_ADDR'])? $_SERVER['SERVER_ADDR'] : '::1'; 38 | $values['state'] = $this->getStateByCountryIso3($values['country'], $values['state']); 39 | $values['state_shipping'] = $this->getStateByCountryIso3($values['country'], $values['state_shipping']); 40 | return json_decode($this->runPost(PAYPAGE_URL, $values)); 41 | } 42 | /** 43 | * Field state and state_shipping should return state to 2 characters for Canada and USA 44 | * A country returns ISO 3 characters, but states requires two characters 45 | */ 46 | private function getStateByCountryIso3($value, $state) { 47 | if (in_array($value, ['CA', 'USA'])) { 48 | if (strlen($state) > 2) { 49 | trigger_error("A state/state_shipping for USA and Canada should return only 2 characters."); 50 | } 51 | } 52 | 53 | // Return full state name 54 | return $state; 55 | } 56 | function send_request(){ 57 | $values['ip_customer'] = $_SERVER['REMOTE_ADDR']; 58 | $values['ip_merchant'] = isset($_SERVER['SERVER_ADDR'])? $_SERVER['SERVER_ADDR'] : '::1'; 59 | return json_decode($this->runPost(TESTING, $values)); 60 | } 61 | function verify_payment($payment_reference){ 62 | $values['merchant_email'] = $this->merchant_email; 63 | $values['secret_key'] = $this->merchant_secretKey; 64 | $values['payment_reference'] = $payment_reference; 65 | return json_decode($this->runPost(VERIFY_URL, $values)); 66 | } 67 | function runPost($url, $fields) { 68 | $fields_string = ""; 69 | foreach ($fields as $key => $value) { 70 | $fields_string .= $key . '=' . $value . '&'; 71 | } 72 | rtrim($fields_string, '&'); 73 | $ch = curl_init(); 74 | $ip = $_SERVER['REMOTE_ADDR']; 75 | $ip_address = array( 76 | "REMOTE_ADDR" => $ip, 77 | "HTTP_X_FORWARDED_FOR" => $ip 78 | ); 79 | curl_setopt($ch, CURLOPT_URL, $url); 80 | curl_setopt($ch, CURLOPT_HTTPHEADER, $ip_address); 81 | curl_setopt($ch, CURLOPT_POST, count($fields)); 82 | curl_setopt($ch, CURLOPT_POSTFIELDS, $fields_string); 83 | curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); 84 | curl_setopt($ch, CURLOPT_REFERER, 1); 85 | $result = curl_exec($ch); 86 | curl_close($ch); 87 | return $result; 88 | } 89 | } 90 | -------------------------------------------------------------------------------- /LICENSE.TXT: -------------------------------------------------------------------------------- 1 | ********************************************************************** 2 | * TCPDF LICENSE 3 | ********************************************************************** 4 | 5 | TCPDF is free software: you can redistribute it and/or modify it 6 | under the terms of the GNU Lesser General Public License as 7 | published by the Free Software Foundation, either version 3 of the 8 | License, or (at your option) any later version. 9 | 10 | ********************************************************************** 11 | ********************************************************************** 12 | 13 | GNU LESSER GENERAL PUBLIC LICENSE 14 | Version 3, 29 June 2007 15 | 16 | Copyright (C) 2007 Free Software Foundation, Inc. 17 | Everyone is permitted to copy and distribute verbatim copies 18 | of this license document, but changing it is not allowed. 19 | 20 | 21 | This version of the GNU Lesser General Public License incorporates 22 | the terms and conditions of version 3 of the GNU General Public 23 | License, supplemented by the additional permissions listed below. 24 | 25 | 0. Additional Definitions. 26 | 27 | As used herein, "this License" refers to version 3 of the GNU Lesser 28 | General Public License, and the "GNU GPL" refers to version 3 of the GNU 29 | General Public License. 30 | 31 | "The Library" refers to a covered work governed by this License, 32 | other than an Application or a Combined Work as defined below. 33 | 34 | An "Application" is any work that makes use of an interface provided 35 | by the Library, but which is not otherwise based on the Library. 36 | Defining a subclass of a class defined by the Library is deemed a mode 37 | of using an interface provided by the Library. 38 | 39 | A "Combined Work" is a work produced by combining or linking an 40 | Application with the Library. The particular version of the Library 41 | with which the Combined Work was made is also called the "Linked 42 | Version". 43 | 44 | The "Minimal Corresponding Source" for a Combined Work means the 45 | Corresponding Source for the Combined Work, excluding any source code 46 | for portions of the Combined Work that, considered in isolation, are 47 | based on the Application, and not on the Linked Version. 48 | 49 | The "Corresponding Application Code" for a Combined Work means the 50 | object code and/or source code for the Application, including any data 51 | and utility programs needed for reproducing the Combined Work from the 52 | Application, but excluding the System Libraries of the Combined Work. 53 | 54 | 1. Exception to Section 3 of the GNU GPL. 55 | 56 | You may convey a covered work under sections 3 and 4 of this License 57 | without being bound by section 3 of the GNU GPL. 58 | 59 | 2. Conveying Modified Versions. 60 | 61 | If you modify a copy of the Library, and, in your modifications, a 62 | facility refers to a function or data to be supplied by an Application 63 | that uses the facility (other than as an argument passed when the 64 | facility is invoked), then you may convey a copy of the modified 65 | version: 66 | 67 | a) under this License, provided that you make a good faith effort to 68 | ensure that, in the event an Application does not supply the 69 | function or data, the facility still operates, and performs 70 | whatever part of its purpose remains meaningful, or 71 | 72 | b) under the GNU GPL, with none of the additional permissions of 73 | this License applicable to that copy. 74 | 75 | 3. Object Code Incorporating Material from Library Header Files. 76 | 77 | The object code form of an Application may incorporate material from 78 | a header file that is part of the Library. You may convey such object 79 | code under terms of your choice, provided that, if the incorporated 80 | material is not limited to numerical parameters, data structure 81 | layouts and accessors, or small macros, inline functions and templates 82 | (ten or fewer lines in length), you do both of the following: 83 | 84 | a) Give prominent notice with each copy of the object code that the 85 | Library is used in it and that the Library and its use are 86 | covered by this License. 87 | 88 | b) Accompany the object code with a copy of the GNU GPL and this license 89 | document. 90 | 91 | 4. Combined Works. 92 | 93 | You may convey a Combined Work under terms of your choice that, 94 | taken together, effectively do not restrict modification of the 95 | portions of the Library contained in the Combined Work and reverse 96 | engineering for debugging such modifications, if you also do each of 97 | the following: 98 | 99 | a) Give prominent notice with each copy of the Combined Work that 100 | the Library is used in it and that the Library and its use are 101 | covered by this License. 102 | 103 | b) Accompany the Combined Work with a copy of the GNU GPL and this license 104 | document. 105 | 106 | c) For a Combined Work that displays copyright notices during 107 | execution, include the copyright notice for the Library among 108 | these notices, as well as a reference directing the user to the 109 | copies of the GNU GPL and this license document. 110 | 111 | d) Do one of the following: 112 | 113 | 0) Convey the Minimal Corresponding Source under the terms of this 114 | License, and the Corresponding Application Code in a form 115 | suitable for, and under terms that permit, the user to 116 | recombine or relink the Application with a modified version of 117 | the Linked Version to produce a modified Combined Work, in the 118 | manner specified by section 6 of the GNU GPL for conveying 119 | Corresponding Source. 120 | 121 | 1) Use a suitable shared library mechanism for linking with the 122 | Library. A suitable mechanism is one that (a) uses at run time 123 | a copy of the Library already present on the user's computer 124 | system, and (b) will operate properly with a modified version 125 | of the Library that is interface-compatible with the Linked 126 | Version. 127 | 128 | e) Provide Installation Information, but only if you would otherwise 129 | be required to provide such information under section 6 of the 130 | GNU GPL, and only to the extent that such information is 131 | necessary to install and execute a modified version of the 132 | Combined Work produced by recombining or relinking the 133 | Application with a modified version of the Linked Version. (If 134 | you use option 4d0, the Installation Information must accompany 135 | the Minimal Corresponding Source and Corresponding Application 136 | Code. If you use option 4d1, you must provide the Installation 137 | Information in the manner specified by section 6 of the GNU GPL 138 | for conveying Corresponding Source.) 139 | 140 | 5. Combined Libraries. 141 | 142 | You may place library facilities that are a work based on the 143 | Library side by side in a single library together with other library 144 | facilities that are not Applications and are not covered by this 145 | License, and convey such a combined library under terms of your 146 | choice, if you do both of the following: 147 | 148 | a) Accompany the combined library with a copy of the same work based 149 | on the Library, uncombined with any other library facilities, 150 | conveyed under the terms of this License. 151 | 152 | b) Give prominent notice with the combined library that part of it 153 | is a work based on the Library, and explaining where to find the 154 | accompanying uncombined form of the same work. 155 | 156 | 6. Revised Versions of the GNU Lesser General Public License. 157 | 158 | The Free Software Foundation may publish revised and/or new versions 159 | of the GNU Lesser General Public License from time to time. Such new 160 | versions will be similar in spirit to the present version, but may 161 | differ in detail to address new problems or concerns. 162 | 163 | Each version is given a distinguishing version number. If the 164 | Library as you received it specifies that a certain numbered version 165 | of the GNU Lesser General Public License "or any later version" 166 | applies to it, you have the option of following the terms and 167 | conditions either of that published version or of any later version 168 | published by the Free Software Foundation. If the Library as you 169 | received it does not specify a version number of the GNU Lesser 170 | General Public License, you may choose any version of the GNU Lesser 171 | General Public License ever published by the Free Software Foundation. 172 | 173 | If the Library as you received it specifies that a proxy can decide 174 | whether future versions of the GNU Lesser General Public License shall 175 | apply, that proxy's public statement of acceptance of any version is 176 | permanent authorization for you to choose that version for the 177 | Library. 178 | 179 | ********************************************************************** 180 | ********************************************************************** 181 | 182 | GNU GENERAL PUBLIC LICENSE 183 | Version 3, 29 June 2007 184 | 185 | Copyright (C) 2007 Free Software Foundation, Inc. 186 | Everyone is permitted to copy and distribute verbatim copies 187 | of this license document, but changing it is not allowed. 188 | 189 | Preamble 190 | 191 | The GNU General Public License is a free, copyleft license for 192 | software and other kinds of works. 193 | 194 | The licenses for most software and other practical works are designed 195 | to take away your freedom to share and change the works. By contrast, 196 | the GNU General Public License is intended to guarantee your freedom to 197 | share and change all versions of a program--to make sure it remains free 198 | software for all its users. We, the Free Software Foundation, use the 199 | GNU General Public License for most of our software; it applies also to 200 | any other work released this way by its authors. You can apply it to 201 | your programs, too. 202 | 203 | When we speak of free software, we are referring to freedom, not 204 | price. Our General Public Licenses are designed to make sure that you 205 | have the freedom to distribute copies of free software (and charge for 206 | them if you wish), that you receive source code or can get it if you 207 | want it, that you can change the software or use pieces of it in new 208 | free programs, and that you know you can do these things. 209 | 210 | To protect your rights, we need to prevent others from denying you 211 | these rights or asking you to surrender the rights. Therefore, you have 212 | certain responsibilities if you distribute copies of the software, or if 213 | you modify it: responsibilities to respect the freedom of others. 214 | 215 | For example, if you distribute copies of such a program, whether 216 | gratis or for a fee, you must pass on to the recipients the same 217 | freedoms that you received. You must make sure that they, too, receive 218 | or can get the source code. And you must show them these terms so they 219 | know their rights. 220 | 221 | Developers that use the GNU GPL protect your rights with two steps: 222 | (1) assert copyright on the software, and (2) offer you this License 223 | giving you legal permission to copy, distribute and/or modify it. 224 | 225 | For the developers' and authors' protection, the GPL clearly explains 226 | that there is no warranty for this free software. For both users' and 227 | authors' sake, the GPL requires that modified versions be marked as 228 | changed, so that their problems will not be attributed erroneously to 229 | authors of previous versions. 230 | 231 | Some devices are designed to deny users access to install or run 232 | modified versions of the software inside them, although the manufacturer 233 | can do so. This is fundamentally incompatible with the aim of 234 | protecting users' freedom to change the software. The systematic 235 | pattern of such abuse occurs in the area of products for individuals to 236 | use, which is precisely where it is most unacceptable. Therefore, we 237 | have designed this version of the GPL to prohibit the practice for those 238 | products. If such problems arise substantially in other domains, we 239 | stand ready to extend this provision to those domains in future versions 240 | of the GPL, as needed to protect the freedom of users. 241 | 242 | Finally, every program is threatened constantly by software patents. 243 | States should not allow patents to restrict development and use of 244 | software on general-purpose computers, but in those that do, we wish to 245 | avoid the special danger that patents applied to a free program could 246 | make it effectively proprietary. To prevent this, the GPL assures that 247 | patents cannot be used to render the program non-free. 248 | 249 | The precise terms and conditions for copying, distribution and 250 | modification follow. 251 | 252 | TERMS AND CONDITIONS 253 | 254 | 0. Definitions. 255 | 256 | "This License" refers to version 3 of the GNU General Public License. 257 | 258 | "Copyright" also means copyright-like laws that apply to other kinds of 259 | works, such as semiconductor masks. 260 | 261 | "The Program" refers to any copyrightable work licensed under this 262 | License. Each licensee is addressed as "you". "Licensees" and 263 | "recipients" may be individuals or organizations. 264 | 265 | To "modify" a work means to copy from or adapt all or part of the work 266 | in a fashion requiring copyright permission, other than the making of an 267 | exact copy. The resulting work is called a "modified version" of the 268 | earlier work or a work "based on" the earlier work. 269 | 270 | A "covered work" means either the unmodified Program or a work based 271 | on the Program. 272 | 273 | To "propagate" a work means to do anything with it that, without 274 | permission, would make you directly or secondarily liable for 275 | infringement under applicable copyright law, except executing it on a 276 | computer or modifying a private copy. Propagation includes copying, 277 | distribution (with or without modification), making available to the 278 | public, and in some countries other activities as well. 279 | 280 | To "convey" a work means any kind of propagation that enables other 281 | parties to make or receive copies. Mere interaction with a user through 282 | a computer network, with no transfer of a copy, is not conveying. 283 | 284 | An interactive user interface displays "Appropriate Legal Notices" 285 | to the extent that it includes a convenient and prominently visible 286 | feature that (1) displays an appropriate copyright notice, and (2) 287 | tells the user that there is no warranty for the work (except to the 288 | extent that warranties are provided), that licensees may convey the 289 | work under this License, and how to view a copy of this License. If 290 | the interface presents a list of user commands or options, such as a 291 | menu, a prominent item in the list meets this criterion. 292 | 293 | 1. Source Code. 294 | 295 | The "source code" for a work means the preferred form of the work 296 | for making modifications to it. "Object code" means any non-source 297 | form of a work. 298 | 299 | A "Standard Interface" means an interface that either is an official 300 | standard defined by a recognized standards body, or, in the case of 301 | interfaces specified for a particular programming language, one that 302 | is widely used among developers working in that language. 303 | 304 | The "System Libraries" of an executable work include anything, other 305 | than the work as a whole, that (a) is included in the normal form of 306 | packaging a Major Component, but which is not part of that Major 307 | Component, and (b) serves only to enable use of the work with that 308 | Major Component, or to implement a Standard Interface for which an 309 | implementation is available to the public in source code form. A 310 | "Major Component", in this context, means a major essential component 311 | (kernel, window system, and so on) of the specific operating system 312 | (if any) on which the executable work runs, or a compiler used to 313 | produce the work, or an object code interpreter used to run it. 314 | 315 | The "Corresponding Source" for a work in object code form means all 316 | the source code needed to generate, install, and (for an executable 317 | work) run the object code and to modify the work, including scripts to 318 | control those activities. However, it does not include the work's 319 | System Libraries, or general-purpose tools or generally available free 320 | programs which are used unmodified in performing those activities but 321 | which are not part of the work. For example, Corresponding Source 322 | includes interface definition files associated with source files for 323 | the work, and the source code for shared libraries and dynamically 324 | linked subprograms that the work is specifically designed to require, 325 | such as by intimate data communication or control flow between those 326 | subprograms and other parts of the work. 327 | 328 | The Corresponding Source need not include anything that users 329 | can regenerate automatically from other parts of the Corresponding 330 | Source. 331 | 332 | The Corresponding Source for a work in source code form is that 333 | same work. 334 | 335 | 2. Basic Permissions. 336 | 337 | All rights granted under this License are granted for the term of 338 | copyright on the Program, and are irrevocable provided the stated 339 | conditions are met. This License explicitly affirms your unlimited 340 | permission to run the unmodified Program. The output from running a 341 | covered work is covered by this License only if the output, given its 342 | content, constitutes a covered work. This License acknowledges your 343 | rights of fair use or other equivalent, as provided by copyright law. 344 | 345 | You may make, run and propagate covered works that you do not 346 | convey, without conditions so long as your license otherwise remains 347 | in force. You may convey covered works to others for the sole purpose 348 | of having them make modifications exclusively for you, or provide you 349 | with facilities for running those works, provided that you comply with 350 | the terms of this License in conveying all material for which you do 351 | not control copyright. Those thus making or running the covered works 352 | for you must do so exclusively on your behalf, under your direction 353 | and control, on terms that prohibit them from making any copies of 354 | your copyrighted material outside their relationship with you. 355 | 356 | Conveying under any other circumstances is permitted solely under 357 | the conditions stated below. Sublicensing is not allowed; section 10 358 | makes it unnecessary. 359 | 360 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 361 | 362 | No covered work shall be deemed part of an effective technological 363 | measure under any applicable law fulfilling obligations under article 364 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 365 | similar laws prohibiting or restricting circumvention of such 366 | measures. 367 | 368 | When you convey a covered work, you waive any legal power to forbid 369 | circumvention of technological measures to the extent such circumvention 370 | is effected by exercising rights under this License with respect to 371 | the covered work, and you disclaim any intention to limit operation or 372 | modification of the work as a means of enforcing, against the work's 373 | users, your or third parties' legal rights to forbid circumvention of 374 | technological measures. 375 | 376 | 4. Conveying Verbatim Copies. 377 | 378 | You may convey verbatim copies of the Program's source code as you 379 | receive it, in any medium, provided that you conspicuously and 380 | appropriately publish on each copy an appropriate copyright notice; 381 | keep intact all notices stating that this License and any 382 | non-permissive terms added in accord with section 7 apply to the code; 383 | keep intact all notices of the absence of any warranty; and give all 384 | recipients a copy of this License along with the Program. 385 | 386 | You may charge any price or no price for each copy that you convey, 387 | and you may offer support or warranty protection for a fee. 388 | 389 | 5. Conveying Modified Source Versions. 390 | 391 | You may convey a work based on the Program, or the modifications to 392 | produce it from the Program, in the form of source code under the 393 | terms of section 4, provided that you also meet all of these conditions: 394 | 395 | a) The work must carry prominent notices stating that you modified 396 | it, and giving a relevant date. 397 | 398 | b) The work must carry prominent notices stating that it is 399 | released under this License and any conditions added under section 400 | 7. This requirement modifies the requirement in section 4 to 401 | "keep intact all notices". 402 | 403 | c) You must license the entire work, as a whole, under this 404 | License to anyone who comes into possession of a copy. This 405 | License will therefore apply, along with any applicable section 7 406 | additional terms, to the whole of the work, and all its parts, 407 | regardless of how they are packaged. This License gives no 408 | permission to license the work in any other way, but it does not 409 | invalidate such permission if you have separately received it. 410 | 411 | d) If the work has interactive user interfaces, each must display 412 | Appropriate Legal Notices; however, if the Program has interactive 413 | interfaces that do not display Appropriate Legal Notices, your 414 | work need not make them do so. 415 | 416 | A compilation of a covered work with other separate and independent 417 | works, which are not by their nature extensions of the covered work, 418 | and which are not combined with it such as to form a larger program, 419 | in or on a volume of a storage or distribution medium, is called an 420 | "aggregate" if the compilation and its resulting copyright are not 421 | used to limit the access or legal rights of the compilation's users 422 | beyond what the individual works permit. Inclusion of a covered work 423 | in an aggregate does not cause this License to apply to the other 424 | parts of the aggregate. 425 | 426 | 6. Conveying Non-Source Forms. 427 | 428 | You may convey a covered work in object code form under the terms 429 | of sections 4 and 5, provided that you also convey the 430 | machine-readable Corresponding Source under the terms of this License, 431 | in one of these ways: 432 | 433 | a) Convey the object code in, or embodied in, a physical product 434 | (including a physical distribution medium), accompanied by the 435 | Corresponding Source fixed on a durable physical medium 436 | customarily used for software interchange. 437 | 438 | b) Convey the object code in, or embodied in, a physical product 439 | (including a physical distribution medium), accompanied by a 440 | written offer, valid for at least three years and valid for as 441 | long as you offer spare parts or customer support for that product 442 | model, to give anyone who possesses the object code either (1) a 443 | copy of the Corresponding Source for all the software in the 444 | product that is covered by this License, on a durable physical 445 | medium customarily used for software interchange, for a price no 446 | more than your reasonable cost of physically performing this 447 | conveying of source, or (2) access to copy the 448 | Corresponding Source from a network server at no charge. 449 | 450 | c) Convey individual copies of the object code with a copy of the 451 | written offer to provide the Corresponding Source. This 452 | alternative is allowed only occasionally and noncommercially, and 453 | only if you received the object code with such an offer, in accord 454 | with subsection 6b. 455 | 456 | d) Convey the object code by offering access from a designated 457 | place (gratis or for a charge), and offer equivalent access to the 458 | Corresponding Source in the same way through the same place at no 459 | further charge. You need not require recipients to copy the 460 | Corresponding Source along with the object code. If the place to 461 | copy the object code is a network server, the Corresponding Source 462 | may be on a different server (operated by you or a third party) 463 | that supports equivalent copying facilities, provided you maintain 464 | clear directions next to the object code saying where to find the 465 | Corresponding Source. Regardless of what server hosts the 466 | Corresponding Source, you remain obligated to ensure that it is 467 | available for as long as needed to satisfy these requirements. 468 | 469 | e) Convey the object code using peer-to-peer transmission, provided 470 | you inform other peers where the object code and Corresponding 471 | Source of the work are being offered to the general public at no 472 | charge under subsection 6d. 473 | 474 | A separable portion of the object code, whose source code is excluded 475 | from the Corresponding Source as a System Library, need not be 476 | included in conveying the object code work. 477 | 478 | A "User Product" is either (1) a "consumer product", which means any 479 | tangible personal property which is normally used for personal, family, 480 | or household purposes, or (2) anything designed or sold for incorporation 481 | into a dwelling. In determining whether a product is a consumer product, 482 | doubtful cases shall be resolved in favor of coverage. For a particular 483 | product received by a particular user, "normally used" refers to a 484 | typical or common use of that class of product, regardless of the status 485 | of the particular user or of the way in which the particular user 486 | actually uses, or expects or is expected to use, the product. A product 487 | is a consumer product regardless of whether the product has substantial 488 | commercial, industrial or non-consumer uses, unless such uses represent 489 | the only significant mode of use of the product. 490 | 491 | "Installation Information" for a User Product means any methods, 492 | procedures, authorization keys, or other information required to install 493 | and execute modified versions of a covered work in that User Product from 494 | a modified version of its Corresponding Source. The information must 495 | suffice to ensure that the continued functioning of the modified object 496 | code is in no case prevented or interfered with solely because 497 | modification has been made. 498 | 499 | If you convey an object code work under this section in, or with, or 500 | specifically for use in, a User Product, and the conveying occurs as 501 | part of a transaction in which the right of possession and use of the 502 | User Product is transferred to the recipient in perpetuity or for a 503 | fixed term (regardless of how the transaction is characterized), the 504 | Corresponding Source conveyed under this section must be accompanied 505 | by the Installation Information. But this requirement does not apply 506 | if neither you nor any third party retains the ability to install 507 | modified object code on the User Product (for example, the work has 508 | been installed in ROM). 509 | 510 | The requirement to provide Installation Information does not include a 511 | requirement to continue to provide support service, warranty, or updates 512 | for a work that has been modified or installed by the recipient, or for 513 | the User Product in which it has been modified or installed. Access to a 514 | network may be denied when the modification itself materially and 515 | adversely affects the operation of the network or violates the rules and 516 | protocols for communication across the network. 517 | 518 | Corresponding Source conveyed, and Installation Information provided, 519 | in accord with this section must be in a format that is publicly 520 | documented (and with an implementation available to the public in 521 | source code form), and must require no special password or key for 522 | unpacking, reading or copying. 523 | 524 | 7. Additional Terms. 525 | 526 | "Additional permissions" are terms that supplement the terms of this 527 | License by making exceptions from one or more of its conditions. 528 | Additional permissions that are applicable to the entire Program shall 529 | be treated as though they were included in this License, to the extent 530 | that they are valid under applicable law. If additional permissions 531 | apply only to part of the Program, that part may be used separately 532 | under those permissions, but the entire Program remains governed by 533 | this License without regard to the additional permissions. 534 | 535 | When you convey a copy of a covered work, you may at your option 536 | remove any additional permissions from that copy, or from any part of 537 | it. (Additional permissions may be written to require their own 538 | removal in certain cases when you modify the work.) You may place 539 | additional permissions on material, added by you to a covered work, 540 | for which you have or can give appropriate copyright permission. 541 | 542 | Notwithstanding any other provision of this License, for material you 543 | add to a covered work, you may (if authorized by the copyright holders of 544 | that material) supplement the terms of this License with terms: 545 | 546 | a) Disclaiming warranty or limiting liability differently from the 547 | terms of sections 15 and 16 of this License; or 548 | 549 | b) Requiring preservation of specified reasonable legal notices or 550 | author attributions in that material or in the Appropriate Legal 551 | Notices displayed by works containing it; or 552 | 553 | c) Prohibiting misrepresentation of the origin of that material, or 554 | requiring that modified versions of such material be marked in 555 | reasonable ways as different from the original version; or 556 | 557 | d) Limiting the use for publicity purposes of names of licensors or 558 | authors of the material; or 559 | 560 | e) Declining to grant rights under trademark law for use of some 561 | trade names, trademarks, or service marks; or 562 | 563 | f) Requiring indemnification of licensors and authors of that 564 | material by anyone who conveys the material (or modified versions of 565 | it) with contractual assumptions of liability to the recipient, for 566 | any liability that these contractual assumptions directly impose on 567 | those licensors and authors. 568 | 569 | All other non-permissive additional terms are considered "further 570 | restrictions" within the meaning of section 10. If the Program as you 571 | received it, or any part of it, contains a notice stating that it is 572 | governed by this License along with a term that is a further 573 | restriction, you may remove that term. If a license document contains 574 | a further restriction but permits relicensing or conveying under this 575 | License, you may add to a covered work material governed by the terms 576 | of that license document, provided that the further restriction does 577 | not survive such relicensing or conveying. 578 | 579 | If you add terms to a covered work in accord with this section, you 580 | must place, in the relevant source files, a statement of the 581 | additional terms that apply to those files, or a notice indicating 582 | where to find the applicable terms. 583 | 584 | Additional terms, permissive or non-permissive, may be stated in the 585 | form of a separately written license, or stated as exceptions; 586 | the above requirements apply either way. 587 | 588 | 8. Termination. 589 | 590 | You may not propagate or modify a covered work except as expressly 591 | provided under this License. Any attempt otherwise to propagate or 592 | modify it is void, and will automatically terminate your rights under 593 | this License (including any patent licenses granted under the third 594 | paragraph of section 11). 595 | 596 | However, if you cease all violation of this License, then your 597 | license from a particular copyright holder is reinstated (a) 598 | provisionally, unless and until the copyright holder explicitly and 599 | finally terminates your license, and (b) permanently, if the copyright 600 | holder fails to notify you of the violation by some reasonable means 601 | prior to 60 days after the cessation. 602 | 603 | Moreover, your license from a particular copyright holder is 604 | reinstated permanently if the copyright holder notifies you of the 605 | violation by some reasonable means, this is the first time you have 606 | received notice of violation of this License (for any work) from that 607 | copyright holder, and you cure the violation prior to 30 days after 608 | your receipt of the notice. 609 | 610 | Termination of your rights under this section does not terminate the 611 | licenses of parties who have received copies or rights from you under 612 | this License. If your rights have been terminated and not permanently 613 | reinstated, you do not qualify to receive new licenses for the same 614 | material under section 10. 615 | 616 | 9. Acceptance Not Required for Having Copies. 617 | 618 | You are not required to accept this License in order to receive or 619 | run a copy of the Program. Ancillary propagation of a covered work 620 | occurring solely as a consequence of using peer-to-peer transmission 621 | to receive a copy likewise does not require acceptance. However, 622 | nothing other than this License grants you permission to propagate or 623 | modify any covered work. These actions infringe copyright if you do 624 | not accept this License. Therefore, by modifying or propagating a 625 | covered work, you indicate your acceptance of this License to do so. 626 | 627 | 10. Automatic Licensing of Downstream Recipients. 628 | 629 | Each time you convey a covered work, the recipient automatically 630 | receives a license from the original licensors, to run, modify and 631 | propagate that work, subject to this License. You are not responsible 632 | for enforcing compliance by third parties with this License. 633 | 634 | An "entity transaction" is a transaction transferring control of an 635 | organization, or substantially all assets of one, or subdividing an 636 | organization, or merging organizations. If propagation of a covered 637 | work results from an entity transaction, each party to that 638 | transaction who receives a copy of the work also receives whatever 639 | licenses to the work the party's predecessor in interest had or could 640 | give under the previous paragraph, plus a right to possession of the 641 | Corresponding Source of the work from the predecessor in interest, if 642 | the predecessor has it or can get it with reasonable efforts. 643 | 644 | You may not impose any further restrictions on the exercise of the 645 | rights granted or affirmed under this License. For example, you may 646 | not impose a license fee, royalty, or other charge for exercise of 647 | rights granted under this License, and you may not initiate litigation 648 | (including a cross-claim or counterclaim in a lawsuit) alleging that 649 | any patent claim is infringed by making, using, selling, offering for 650 | sale, or importing the Program or any portion of it. 651 | 652 | 11. Patents. 653 | 654 | A "contributor" is a copyright holder who authorizes use under this 655 | License of the Program or a work on which the Program is based. The 656 | work thus licensed is called the contributor's "contributor version". 657 | 658 | A contributor's "essential patent claims" are all patent claims 659 | owned or controlled by the contributor, whether already acquired or 660 | hereafter acquired, that would be infringed by some manner, permitted 661 | by this License, of making, using, or selling its contributor version, 662 | but do not include claims that would be infringed only as a 663 | consequence of further modification of the contributor version. For 664 | purposes of this definition, "control" includes the right to grant 665 | patent sublicenses in a manner consistent with the requirements of 666 | this License. 667 | 668 | Each contributor grants you a non-exclusive, worldwide, royalty-free 669 | patent license under the contributor's essential patent claims, to 670 | make, use, sell, offer for sale, import and otherwise run, modify and 671 | propagate the contents of its contributor version. 672 | 673 | In the following three paragraphs, a "patent license" is any express 674 | agreement or commitment, however denominated, not to enforce a patent 675 | (such as an express permission to practice a patent or covenant not to 676 | sue for patent infringement). To "grant" such a patent license to a 677 | party means to make such an agreement or commitment not to enforce a 678 | patent against the party. 679 | 680 | If you convey a covered work, knowingly relying on a patent license, 681 | and the Corresponding Source of the work is not available for anyone 682 | to copy, free of charge and under the terms of this License, through a 683 | publicly available network server or other readily accessible means, 684 | then you must either (1) cause the Corresponding Source to be so 685 | available, or (2) arrange to deprive yourself of the benefit of the 686 | patent license for this particular work, or (3) arrange, in a manner 687 | consistent with the requirements of this License, to extend the patent 688 | license to downstream recipients. "Knowingly relying" means you have 689 | actual knowledge that, but for the patent license, your conveying the 690 | covered work in a country, or your recipient's use of the covered work 691 | in a country, would infringe one or more identifiable patents in that 692 | country that you have reason to believe are valid. 693 | 694 | If, pursuant to or in connection with a single transaction or 695 | arrangement, you convey, or propagate by procuring conveyance of, a 696 | covered work, and grant a patent license to some of the parties 697 | receiving the covered work authorizing them to use, propagate, modify 698 | or convey a specific copy of the covered work, then the patent license 699 | you grant is automatically extended to all recipients of the covered 700 | work and works based on it. 701 | 702 | A patent license is "discriminatory" if it does not include within 703 | the scope of its coverage, prohibits the exercise of, or is 704 | conditioned on the non-exercise of one or more of the rights that are 705 | specifically granted under this License. You may not convey a covered 706 | work if you are a party to an arrangement with a third party that is 707 | in the business of distributing software, under which you make payment 708 | to the third party based on the extent of your activity of conveying 709 | the work, and under which the third party grants, to any of the 710 | parties who would receive the covered work from you, a discriminatory 711 | patent license (a) in connection with copies of the covered work 712 | conveyed by you (or copies made from those copies), or (b) primarily 713 | for and in connection with specific products or compilations that 714 | contain the covered work, unless you entered into that arrangement, 715 | or that patent license was granted, prior to 28 March 2007. 716 | 717 | Nothing in this License shall be construed as excluding or limiting 718 | any implied license or other defenses to infringement that may 719 | otherwise be available to you under applicable patent law. 720 | 721 | 12. No Surrender of Others' Freedom. 722 | 723 | If conditions are imposed on you (whether by court order, agreement or 724 | otherwise) that contradict the conditions of this License, they do not 725 | excuse you from the conditions of this License. If you cannot convey a 726 | covered work so as to satisfy simultaneously your obligations under this 727 | License and any other pertinent obligations, then as a consequence you may 728 | not convey it at all. For example, if you agree to terms that obligate you 729 | to collect a royalty for further conveying from those to whom you convey 730 | the Program, the only way you could satisfy both those terms and this 731 | License would be to refrain entirely from conveying the Program. 732 | 733 | 13. Use with the GNU Affero General Public License. 734 | 735 | Notwithstanding any other provision of this License, you have 736 | permission to link or combine any covered work with a work licensed 737 | under version 3 of the GNU Affero General Public License into a single 738 | combined work, and to convey the resulting work. The terms of this 739 | License will continue to apply to the part which is the covered work, 740 | but the special requirements of the GNU Affero General Public License, 741 | section 13, concerning interaction through a network will apply to the 742 | combination as such. 743 | 744 | 14. Revised Versions of this License. 745 | 746 | The Free Software Foundation may publish revised and/or new versions of 747 | the GNU General Public License from time to time. Such new versions will 748 | be similar in spirit to the present version, but may differ in detail to 749 | address new problems or concerns. 750 | 751 | Each version is given a distinguishing version number. If the 752 | Program specifies that a certain numbered version of the GNU General 753 | Public License "or any later version" applies to it, you have the 754 | option of following the terms and conditions either of that numbered 755 | version or of any later version published by the Free Software 756 | Foundation. If the Program does not specify a version number of the 757 | GNU General Public License, you may choose any version ever published 758 | by the Free Software Foundation. 759 | 760 | If the Program specifies that a proxy can decide which future 761 | versions of the GNU General Public License can be used, that proxy's 762 | public statement of acceptance of a version permanently authorizes you 763 | to choose that version for the Program. 764 | 765 | Later license versions may give you additional or different 766 | permissions. However, no additional obligations are imposed on any 767 | author or copyright holder as a result of your choosing to follow a 768 | later version. 769 | 770 | 15. Disclaimer of Warranty. 771 | 772 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 773 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 774 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 775 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 776 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 777 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 778 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 779 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 780 | 781 | 16. Limitation of Liability. 782 | 783 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 784 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 785 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 786 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 787 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 788 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 789 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 790 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 791 | SUCH DAMAGES. 792 | 793 | 17. Interpretation of Sections 15 and 16. 794 | 795 | If the disclaimer of warranty and limitation of liability provided 796 | above cannot be given local legal effect according to their terms, 797 | reviewing courts shall apply local law that most closely approximates 798 | an absolute waiver of all civil liability in connection with the 799 | Program, unless a warranty or assumption of liability accompanies a 800 | copy of the Program in return for a fee. 801 | 802 | END OF TERMS AND CONDITIONS 803 | 804 | How to Apply These Terms to Your New Programs 805 | 806 | If you develop a new program, and you want it to be of the greatest 807 | possible use to the public, the best way to achieve this is to make it 808 | free software which everyone can redistribute and change under these terms. 809 | 810 | To do so, attach the following notices to the program. It is safest 811 | to attach them to the start of each source file to most effectively 812 | state the exclusion of warranty; and each file should have at least 813 | the "copyright" line and a pointer to where the full notice is found. 814 | 815 | 816 | Copyright (C) 817 | 818 | This program is free software: you can redistribute it and/or modify 819 | it under the terms of the GNU General Public License as published by 820 | the Free Software Foundation, either version 3 of the License, or 821 | (at your option) any later version. 822 | 823 | This program is distributed in the hope that it will be useful, 824 | but WITHOUT ANY WARRANTY; without even the implied warranty of 825 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 826 | GNU General Public License for more details. 827 | 828 | You should have received a copy of the GNU General Public License 829 | along with this program. If not, see . 830 | 831 | Also add information on how to contact you by electronic and paper mail. 832 | 833 | If the program does terminal interaction, make it output a short 834 | notice like this when it starts in an interactive mode: 835 | 836 | Copyright (C) 837 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 838 | This is free software, and you are welcome to redistribute it 839 | under certain conditions; type `show c' for details. 840 | 841 | The hypothetical commands `show w' and `show c' should show the appropriate 842 | parts of the General Public License. Of course, your program's commands 843 | might be different; for a GUI interface, you would use an "about box". 844 | 845 | You should also get your employer (if you work as a programmer) or school, 846 | if any, to sign a "copyright disclaimer" for the program, if necessary. 847 | For more information on this, and how to apply and follow the GNU GPL, see 848 | . 849 | 850 | The GNU General Public License does not permit incorporating your program 851 | into proprietary programs. If your program is a subroutine library, you 852 | may consider it more useful to permit linking proprietary applications with 853 | the library. If this is what you want to do, use the GNU Lesser General 854 | Public License instead of this License. But first, please read 855 | . 856 | 857 | ********************************************************************** 858 | ********************************************************************** 859 | --------------------------------------------------------------------------------