From 5b06fd97c29ee8d6a61dc5ebfd6c8429a7cef61b Mon Sep 17 00:00:00 2001 From: Philip Berndroth Date: Mon, 27 Jun 2016 20:36:14 +0200 Subject: [PATCH 001/129] fix json_encode for integer values without the parameter JSON_NUMERIC_CHECK the json_encode function is ignoring the integer values from a array or database and then the integer values are serialized into a string. --- application/libraries/Format.php | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/application/libraries/Format.php b/application/libraries/Format.php index 0b6a496d..2132b649 100644 --- a/application/libraries/Format.php +++ b/application/libraries/Format.php @@ -403,14 +403,14 @@ public function to_json($data = NULL) if (empty($callback) === TRUE) { - return json_encode($data); + return json_encode($data, JSON_NUMERIC_CHECK); } // We only honour a jsonp callback which are valid javascript identifiers elseif (preg_match('/^[a-z_\$][a-z0-9\$_]*(\.[a-z_\$][a-z0-9\$_]*)*$/i', $callback)) { // Return the data as encoded json with a callback - return $callback.'('.json_encode($data).');'; + return $callback.'('.json_encode($data, JSON_NUMERIC_CHECK).');'; } // An invalid jsonp callback function provided. From 74a280a4401a80f3ca4f64595e98995d8aca58d2 Mon Sep 17 00:00:00 2001 From: softwarespot Date: Sun, 10 Jul 2016 07:30:20 +0300 Subject: [PATCH 002/129] Minor style guide fixes --- application/libraries/Format.php | 1 - application/libraries/REST_Controller.php | 30 +++++++++++------------ 2 files changed, 14 insertions(+), 17 deletions(-) diff --git a/application/libraries/Format.php b/application/libraries/Format.php index 2132b649..00129b28 100644 --- a/application/libraries/Format.php +++ b/application/libraries/Format.php @@ -521,5 +521,4 @@ protected function _from_php($data) { return trim($data); } - } diff --git a/application/libraries/REST_Controller.php b/application/libraries/REST_Controller.php index 299b9e69..d0b354c0 100644 --- a/application/libraries/REST_Controller.php +++ b/application/libraries/REST_Controller.php @@ -589,7 +589,6 @@ public function __destruct() /** * Checks to see if we have everything we need to run this library. * - * @author Chris Kacerguis * @access protected * @return Exception */ @@ -615,8 +614,8 @@ protected function preflight_checks() * Controller method * * @access public - * @param string $object_called - * @param array $arguments The arguments passed to the controller method + * @param string $object_called + * @param array $arguments The arguments passed to the controller method */ public function _remap($object_called, $arguments = []) { @@ -669,7 +668,7 @@ public function _remap($object_called, $arguments = []) } // Sure it exists, but can they do anything with it? - if (!method_exists($this, $controller_method)) + if (! method_exists($this, $controller_method)) { $this->response([ $this->config->item('rest_status_field_name') => FALSE, @@ -1118,7 +1117,7 @@ protected function _log_request($authorized = FALSE) * Check if the requests to a controller method exceed a limit * * @access protected - * @param string $controller_method The method being called + * @param string $controller_method The method being called * @return bool TRUE the call limit is below the threshold; otherwise, FALSE */ protected function _check_limit($controller_method) @@ -1694,8 +1693,8 @@ public function query($key = NULL, $xss_clean = NULL) * prevented * * @access protected - * @param string $value Input data - * @param bool $xss_clean Whether to apply XSS filtering + * @param string $value Input data + * @param bool $xss_clean Whether to apply XSS filtering * @return string */ protected function _xss_clean($value, $xss_clean) @@ -1724,8 +1723,8 @@ public function validation_errors() * Perform LDAP Authentication * * @access protected - * @param string $username The username to validate - * @param string $password The password to validate + * @param string $username The username to validate + * @param string $password The password to validate * @return bool */ protected function _perform_ldap_auth($username = '', $password = NULL) @@ -1819,8 +1818,8 @@ protected function _perform_ldap_auth($username = '', $password = NULL) * Perform Library Authentication - Override this function to change the way the library is called * * @access protected - * @param string $username The username to validate - * @param string $password The password to validate + * @param string $username The username to validate + * @param string $password The password to validate * @return bool */ protected function _perform_library_auth($username = '', $password = NULL) @@ -1858,8 +1857,8 @@ protected function _perform_library_auth($username = '', $password = NULL) * Check if the user is logged in * * @access protected - * @param string $username The user's name - * @param bool|string $password The user's password + * @param string $username The user's name + * @param bool|string $password The user's password * @return bool */ protected function _check_login($username = NULL, $password = FALSE) @@ -2162,12 +2161,12 @@ protected function _check_access() { return TRUE; } - + //check if the key has all_access $accessRow = $this->rest->db ->where('key', $this->rest->key) ->get($this->config->item('rest_access_table'))->row_array(); - + if (!empty($accessRow) && !empty($accessRow['all_access'])) { return TRUE; @@ -2235,5 +2234,4 @@ protected function _check_cors() exit; } } - } From 091849652295e44e9a969835d716d983f4b3a45e Mon Sep 17 00:00:00 2001 From: teabrg Date: Mon, 18 Jul 2016 09:11:36 +0200 Subject: [PATCH 003/129] Check if API KEY submitted is activated Quickly deactivate API KEY's from accessing your API in case you do not wish to always go to database, change keys, etc --- application/libraries/REST_Controller.php | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/application/libraries/REST_Controller.php b/application/libraries/REST_Controller.php index 299b9e69..d6174f8e 100644 --- a/application/libraries/REST_Controller.php +++ b/application/libraries/REST_Controller.php @@ -1000,7 +1000,13 @@ protected function _detect_api_key() // Find the key from server or arguments if (($key = isset($this->_args[$api_key_variable]) ? $this->_args[$api_key_variable] : $this->input->server($key_name))) { - if ( ! ($row = $this->rest->db->where($this->config->item('rest_key_column'), $key)->get($this->config->item('rest_keys_table'))->row())) + //if you have a field to check if the API KEY provided by the user is activated or not + //(in case you quickly want to deactivate specific users) + // you can also perform an extra check for this + + $existsactive = $this->db->query("SELECT api_key_activated FROM api_keys WHERE api_key = '".$key."' "); + $isactive = $existsactive->result(); + if ( ! ($row = $this->rest->db->where($this->config->item('rest_key_column'), $key)->get($this->config->item('rest_keys_table'))->row() ) || $isactive[0]->activated == 'no' ) { return FALSE; } From e911a7b5112f815fae14a8f3128a9091ffa57713 Mon Sep 17 00:00:00 2001 From: teabrg Date: Mon, 18 Jul 2016 09:23:07 +0200 Subject: [PATCH 004/129] Update REST_Controller.php --- application/libraries/REST_Controller.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/application/libraries/REST_Controller.php b/application/libraries/REST_Controller.php index d6174f8e..ed1d283f 100644 --- a/application/libraries/REST_Controller.php +++ b/application/libraries/REST_Controller.php @@ -1006,7 +1006,7 @@ protected function _detect_api_key() $existsactive = $this->db->query("SELECT api_key_activated FROM api_keys WHERE api_key = '".$key."' "); $isactive = $existsactive->result(); - if ( ! ($row = $this->rest->db->where($this->config->item('rest_key_column'), $key)->get($this->config->item('rest_keys_table'))->row() ) || $isactive[0]->activated == 'no' ) + if ( ! ($row = $this->rest->db->where($this->config->item('rest_key_column'), $key)->get($this->config->item('rest_keys_table'))->row() ) || $isactive[0]->api_key_activated == 'no' ) { return FALSE; } From 3677830638f74e2e42554b9e5d9addd4b69d6848 Mon Sep 17 00:00:00 2001 From: Chris Kacerguis Date: Sat, 30 Jul 2016 12:51:04 -0500 Subject: [PATCH 005/129] added inital composer file --- composer.json | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 composer.json diff --git a/composer.json b/composer.json new file mode 100644 index 00000000..a4d014d7 --- /dev/null +++ b/composer.json @@ -0,0 +1,16 @@ +{ + "description": "REST Server for the CodeIgniter framework", + "name": "chriskacerguis/codeigniter-restserver", + "type": "project", + "homepage": "https://github.com/chriskacerguis/codeigniter-restserver", + "authors": [ + { + "name": "Chris Kacerguis", + "role": "Developer" + } + ], + "license": "MIT", + "support": { + "source": "https://github.com/chriskacerguis/codeigniter-restserver" + } +} \ No newline at end of file From 32c46b6dffc7fb09fc928f4d13732f7a93abba80 Mon Sep 17 00:00:00 2001 From: Chris Kacerguis Date: Sat, 30 Jul 2016 15:35:27 -0500 Subject: [PATCH 006/129] added .gitignore --- .gitignore | 1 + 1 file changed, 1 insertion(+) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..496ee2ca --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +.DS_Store \ No newline at end of file From 60242fd1e877c2e98f2ca9ed2c1fe850f1cb1c51 Mon Sep 17 00:00:00 2001 From: Chris Kacerguis Date: Sat, 30 Jul 2016 15:38:49 -0500 Subject: [PATCH 007/129] added important note about 4.0.0 --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 59214003..b33b448a 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,12 @@ config file and one controller. _Note: for 1.7.x support download v2.2 from Downloads tab_ +## Important Update on 4.0.0 + +Please note that version 4.0.0 is in the works, and is considered a breaking change (per SemVer). As CI 3.1.0 now has native support for Composer, this library will be moving to be composer based. + +Take a look at the "development" branch to see what's up. + ## Installation Drag and drop the **application/libraries/Format.php** and **application/libraries/REST_Controller.php** files into your application's directories. To use `require_once` it at the top of your controllers to load it into the scope. Additionally, copy the **rest.php** file from **application/config** in your application's configuration directory. From dc290963aaeb14d31f0617b934e5d8a1e396d220 Mon Sep 17 00:00:00 2001 From: Chris Kacerguis Date: Thu, 18 Aug 2016 10:23:17 -0500 Subject: [PATCH 008/129] added vendor to .gitignore --- .gitignore | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index 496ee2ca..47f36f65 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ -.DS_Store \ No newline at end of file +.DS_Store +vendor \ No newline at end of file From 5aaef2cbd0bb2ddc82bcb961be4b435dbb077cf2 Mon Sep 17 00:00:00 2001 From: Chris Kacerguis Date: Thu, 18 Aug 2016 10:26:04 -0500 Subject: [PATCH 009/129] remove JSON_NUMERIC_CHECK --- application/libraries/Format.php | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/application/libraries/Format.php b/application/libraries/Format.php index 00129b28..d078298c 100644 --- a/application/libraries/Format.php +++ b/application/libraries/Format.php @@ -403,14 +403,14 @@ public function to_json($data = NULL) if (empty($callback) === TRUE) { - return json_encode($data, JSON_NUMERIC_CHECK); + return json_encode($data); } // We only honour a jsonp callback which are valid javascript identifiers elseif (preg_match('/^[a-z_\$][a-z0-9\$_]*(\.[a-z_\$][a-z0-9\$_]*)*$/i', $callback)) { // Return the data as encoded json with a callback - return $callback.'('.json_encode($data, JSON_NUMERIC_CHECK).');'; + return $callback.'('.json_encode($data).');'; } // An invalid jsonp callback function provided. From 3f3c0fec16d515c4211b4a0a62fb121bfeab0e9f Mon Sep 17 00:00:00 2001 From: teabrg Date: Tue, 23 Aug 2016 09:29:11 +0200 Subject: [PATCH 010/129] Redo using Query Builder --- application/libraries/REST_Controller.php | 3 +++ 1 file changed, 3 insertions(+) diff --git a/application/libraries/REST_Controller.php b/application/libraries/REST_Controller.php index ed1d283f..be693779 100644 --- a/application/libraries/REST_Controller.php +++ b/application/libraries/REST_Controller.php @@ -1005,6 +1005,9 @@ protected function _detect_api_key() // you can also perform an extra check for this $existsactive = $this->db->query("SELECT api_key_activated FROM api_keys WHERE api_key = '".$key."' "); + // Using the Query builder method. This will only work if you have a column named activated in the api_key table. + //If you also want to add this as a config item replace the get('activated') with $this->config->item('rest_key_activated_column'). + $existsactive = $this->rest->db->where($this->config->item('rest_key_column'), $key)->get('activated')->result(); $isactive = $existsactive->result(); if ( ! ($row = $this->rest->db->where($this->config->item('rest_key_column'), $key)->get($this->config->item('rest_keys_table'))->row() ) || $isactive[0]->api_key_activated == 'no' ) { From 59110a62ecb550c852926757ec81e45ea26fb217 Mon Sep 17 00:00:00 2001 From: Jay Paul Torres Bandas Date: Sun, 4 Sep 2016 08:31:29 -0500 Subject: [PATCH 011/129] Spanish Lang - Fix (#692) --- application/language/spanish/rest_controller_lang.php | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/application/language/spanish/rest_controller_lang.php b/application/language/spanish/rest_controller_lang.php index 962376c7..b6dea8fb 100644 --- a/application/language/spanish/rest_controller_lang.php +++ b/application/language/spanish/rest_controller_lang.php @@ -10,8 +10,8 @@ $lang['text_rest_ip_unauthorized'] = 'IP no autorizada'; $lang['text_rest_unauthorized'] = 'Acceso no autorizado'; $lang['text_rest_ajax_only'] = 'Solo peticiones ajax permitidas'; -$lang['text_rest_api_key_unauthorized'] = 'This API key does not have access to the requested controller'; -$lang['text_rest_api_key_permissions'] = 'This API key does not have enough permissions'; -$lang['text_rest_api_key_time_limit'] = 'This API key has reached the time limit for this method'; -$lang['text_rest_unknown_method'] = 'metodo desconocido'; +$lang['text_rest_api_key_unauthorized'] = 'Esta clave de API no tiene acceso al controlador solicitado'; +$lang['text_rest_api_key_permissions'] = 'Esta clave de API no tiene suficientes permisos'; +$lang['text_rest_api_key_time_limit'] = 'Esta clave de API ha alcanzado el límite de tiempo para este método'; +$lang['text_rest_unknown_method'] = 'método desconocido'; $lang['text_rest_unsupported'] = 'Protocolo no soportado'; From 565ab5332c118be2f743fc71f009570419e533bc Mon Sep 17 00:00:00 2001 From: Eray Akartuna Date: Thu, 8 Sep 2016 02:41:46 +0300 Subject: [PATCH 012/129] Turkish Language (#695) --- application/language/turkish/index.html | 11 +++++++++++ .../language/turkish/rest_controller_lang.php | 17 +++++++++++++++++ 2 files changed, 28 insertions(+) create mode 100644 application/language/turkish/index.html create mode 100644 application/language/turkish/rest_controller_lang.php diff --git a/application/language/turkish/index.html b/application/language/turkish/index.html new file mode 100644 index 00000000..b702fbc3 --- /dev/null +++ b/application/language/turkish/index.html @@ -0,0 +1,11 @@ + + + + 403 Forbidden + + + +

Directory access is forbidden.

+ + + diff --git a/application/language/turkish/rest_controller_lang.php b/application/language/turkish/rest_controller_lang.php new file mode 100644 index 00000000..2efcd2c8 --- /dev/null +++ b/application/language/turkish/rest_controller_lang.php @@ -0,0 +1,17 @@ + Date: Thu, 8 Sep 2016 08:07:34 -0500 Subject: [PATCH 013/129] removed code that was causing issues due to hard codes and non-config options. --- application/libraries/REST_Controller.php | 11 +---------- 1 file changed, 1 insertion(+), 10 deletions(-) diff --git a/application/libraries/REST_Controller.php b/application/libraries/REST_Controller.php index 0fb76fec..d0b354c0 100644 --- a/application/libraries/REST_Controller.php +++ b/application/libraries/REST_Controller.php @@ -999,16 +999,7 @@ protected function _detect_api_key() // Find the key from server or arguments if (($key = isset($this->_args[$api_key_variable]) ? $this->_args[$api_key_variable] : $this->input->server($key_name))) { - //if you have a field to check if the API KEY provided by the user is activated or not - //(in case you quickly want to deactivate specific users) - // you can also perform an extra check for this - - $existsactive = $this->db->query("SELECT api_key_activated FROM api_keys WHERE api_key = '".$key."' "); - // Using the Query builder method. This will only work if you have a column named activated in the api_key table. - //If you also want to add this as a config item replace the get('activated') with $this->config->item('rest_key_activated_column'). - $existsactive = $this->rest->db->where($this->config->item('rest_key_column'), $key)->get('activated')->result(); - $isactive = $existsactive->result(); - if ( ! ($row = $this->rest->db->where($this->config->item('rest_key_column'), $key)->get($this->config->item('rest_keys_table'))->row() ) || $isactive[0]->api_key_activated == 'no' ) + if ( ! ($row = $this->rest->db->where($this->config->item('rest_key_column'), $key)->get($this->config->item('rest_keys_table'))->row())) { return FALSE; } From 079ea94915e558a868879f29e71f51c5e2f6dd84 Mon Sep 17 00:00:00 2001 From: teabrg Date: Thu, 8 Sep 2016 15:08:34 +0200 Subject: [PATCH 014/129] Greek Language Translation (#696) --- .../language/greek/rest_controller_lang.php | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 application/language/greek/rest_controller_lang.php diff --git a/application/language/greek/rest_controller_lang.php b/application/language/greek/rest_controller_lang.php new file mode 100644 index 00000000..319333b2 --- /dev/null +++ b/application/language/greek/rest_controller_lang.php @@ -0,0 +1,17 @@ + Date: Sat, 10 Sep 2016 21:34:49 +0100 Subject: [PATCH 015/129] fix rate limiting (#702) --- application/libraries/REST_Controller.php | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/application/libraries/REST_Controller.php b/application/libraries/REST_Controller.php index d0b354c0..81be0a22 100644 --- a/application/libraries/REST_Controller.php +++ b/application/libraries/REST_Controller.php @@ -1133,12 +1133,10 @@ protected function _check_limit($controller_method) { case 'API_KEY': $limited_uri = 'api-key:' . (isset($this->rest->key) ? $this->rest->key : ''); - $limited_method_name = isset($this->rest->key) ? $this->rest->key : ''; break; case 'METHOD_NAME': $limited_uri = 'method-name:' . $controller_method; - $limited_method_name = $controller_method; break; case 'ROUTED_URL': @@ -1149,20 +1147,19 @@ protected function _check_limit($controller_method) $limited_uri = substr($limited_uri,0, -strlen($this->response->format) - 1); } $limited_uri = 'uri:'.$limited_uri.':'.$this->request->method; // It's good to differentiate GET from PUT - $limited_method_name = $controller_method; break; } - if (isset($this->methods[$limited_method_name]['limit']) === FALSE ) + if (isset($this->methods[$controller_method]['limit']) === FALSE ) { // Everything is fine return TRUE; } // How many times can you get to this method in a defined time_limit (default: 1 hour)? - $limit = $this->methods[$limited_method_name]['limit']; + $limit = $this->methods[$controller_method]['limit']; - $time_limit = (isset($this->methods[$limited_method_name]['time']) ? $this->methods[$limited_method_name]['time'] : 3600); // 3600 = 60 * 60 + $time_limit = (isset($this->methods[$controller_method]['time']) ? $this->methods[$controller_method]['time'] : 3600); // 3600 = 60 * 60 // Get data about a keys' usage and limit to one row $result = $this->rest->db From 4b45c72cb751222eed601f3385209c050c41a0e8 Mon Sep 17 00:00:00 2001 From: TGoC Date: Sat, 10 Sep 2016 21:35:04 +0100 Subject: [PATCH 016/129] typo - example rate limit (#703) --- application/controllers/api/Example.php | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/application/controllers/api/Example.php b/application/controllers/api/Example.php index 2cfecaaf..2f8f9e7a 100644 --- a/application/controllers/api/Example.php +++ b/application/controllers/api/Example.php @@ -25,9 +25,9 @@ function __construct() // Configure limits on our controller methods // Ensure you have created the 'limits' table and enabled 'limits' within application/config/rest.php - $this->methods['user_get']['limit'] = 500; // 500 requests per hour per user/key - $this->methods['user_post']['limit'] = 100; // 100 requests per hour per user/key - $this->methods['user_delete']['limit'] = 50; // 50 requests per hour per user/key + $this->methods['users_get']['limit'] = 500; // 500 requests per hour per user/key + $this->methods['users_post']['limit'] = 100; // 100 requests per hour per user/key + $this->methods['users_delete']['limit'] = 50; // 50 requests per hour per user/key } public function users_get() From 706f3b8375a0f6d1c65224dc112429f02037a572 Mon Sep 17 00:00:00 2001 From: Eray Akartuna Date: Thu, 29 Sep 2016 05:39:04 +0300 Subject: [PATCH 017/129] Limit request by ip address - without rest key (#711) --- application/config/rest.php | 1 + .../bulgarian/rest_controller_lang.php | 1 + .../language/english/rest_controller_lang.php | 1 + .../language/french/rest_controller_lang.php | 1 + .../language/german/rest_controller_lang.php | 1 + .../language/greek/rest_controller_lang.php | 1 + .../rest_controller_lang.php | 1 + .../romanian/rest_controller_lang.php | 1 + .../serbian_cyr/rest_controller_lang.php | 1 + .../serbian_lat/rest_controller_lang.php | 1 + .../rest_controller_lang.php | 1 + .../language/spanish/rest_controller_lang.php | 1 + .../rest_controller_lang.php | 1 + .../language/turkish/rest_controller_lang.php | 1 + application/libraries/REST_Controller.php | 24 +++++++++++++++---- 15 files changed, 33 insertions(+), 5 deletions(-) diff --git a/application/config/rest.php b/application/config/rest.php index a159144e..95ddc5cf 100644 --- a/application/config/rest.php +++ b/application/config/rest.php @@ -334,6 +334,7 @@ | Specify the method used to limit the API calls | | Available methods are : +| $config['rest_limits_method'] = 'IP_ADDRESS'; // Put a limit per ip address | $config['rest_limits_method'] = 'API_KEY'; // Put a limit per api key | $config['rest_limits_method'] = 'METHOD_NAME'; // Put a limit on method calls | $config['rest_limits_method'] = 'ROUTED_URL'; // Put a limit on the routed URL diff --git a/application/language/bulgarian/rest_controller_lang.php b/application/language/bulgarian/rest_controller_lang.php index 6145307d..1dec8515 100644 --- a/application/language/bulgarian/rest_controller_lang.php +++ b/application/language/bulgarian/rest_controller_lang.php @@ -13,5 +13,6 @@ $lang['text_rest_api_key_unauthorized'] = 'API ключът не е оторизиран зо достъп до заявения контролер'; $lang['text_rest_api_key_permissions'] = 'API ключът няма достатъчно права'; $lang['text_rest_api_key_time_limit'] = 'API ключът е изполван с превишаване на времевия лимит за този метод'; +$lang['text_rest_ip_address_time_limit'] = 'This IP Address has reached the time limit for this method';//todo translate $lang['text_rest_unknown_method'] = 'Неизвестен метод'; $lang['text_rest_unsupported'] = 'Неподдържан протокол'; diff --git a/application/language/english/rest_controller_lang.php b/application/language/english/rest_controller_lang.php index 1c665bdc..06bf4b96 100644 --- a/application/language/english/rest_controller_lang.php +++ b/application/language/english/rest_controller_lang.php @@ -13,5 +13,6 @@ $lang['text_rest_api_key_unauthorized'] = 'This API key does not have access to the requested controller'; $lang['text_rest_api_key_permissions'] = 'This API key does not have enough permissions'; $lang['text_rest_api_key_time_limit'] = 'This API key has reached the time limit for this method'; +$lang['text_rest_ip_address_time_limit'] = 'This IP Address has reached the time limit for this method'; $lang['text_rest_unknown_method'] = 'Unknown method'; $lang['text_rest_unsupported'] = 'Unsupported protocol'; diff --git a/application/language/french/rest_controller_lang.php b/application/language/french/rest_controller_lang.php index fb5727f5..f8c0d13f 100644 --- a/application/language/french/rest_controller_lang.php +++ b/application/language/french/rest_controller_lang.php @@ -13,5 +13,6 @@ $lang['text_rest_api_key_unauthorized'] = 'Cette clef d\'API n\'a pas accès au contrôleur demandé'; $lang['text_rest_api_key_permissions'] = 'Cette clef d\'API n\'a pas les permissions requises'; $lang['text_rest_api_key_time_limit'] = 'Cette clef d\'API a atteint sa limite de temps pour cette méthode'; +$lang['text_rest_ip_address_time_limit'] = 'This IP Address has reached the time limit for this method';//todo translate $lang['text_rest_unknown_method'] = 'Méthode inconnue'; $lang['text_rest_unsupported'] = 'Protocole non-supporté'; diff --git a/application/language/german/rest_controller_lang.php b/application/language/german/rest_controller_lang.php index 012d0363..4230c3cd 100644 --- a/application/language/german/rest_controller_lang.php +++ b/application/language/german/rest_controller_lang.php @@ -13,5 +13,6 @@ $lang['text_rest_api_key_unauthorized'] = 'Dieser API Schlüssel hat keinen Zugriff auf den angeforderten Controller'; $lang['text_rest_api_key_permissions'] = 'Dieser API Schlüssel besitzt die erforderlichen Rechte nicht'; $lang['text_rest_api_key_time_limit'] = 'Dieser API Schlüssel ist abgelaufen'; +$lang['text_rest_ip_address_time_limit'] = 'This IP Address has reached the time limit for this method';//todo translate $lang['text_rest_unknown_method'] = 'Unbekannte Methode'; $lang['text_rest_unsupported'] = 'Protokoll nicht unterstützt'; diff --git a/application/language/greek/rest_controller_lang.php b/application/language/greek/rest_controller_lang.php index 319333b2..f85b0673 100644 --- a/application/language/greek/rest_controller_lang.php +++ b/application/language/greek/rest_controller_lang.php @@ -13,5 +13,6 @@ $lang['text_rest_api_key_unauthorized'] = 'Αυτό το API key δεν έχει πρόσβαση στον συγκεκριμένο controller'; $lang['text_rest_api_key_permissions'] = 'Αυτό το API key δεν έχει αρκετά δικαιώματα'; $lang['text_rest_api_key_time_limit'] = 'Αυτό το API key έχει φτάσει στο μέγιστο όριο requests για την συγκεκριμένη μέθοδο'; +$lang['text_rest_ip_address_time_limit'] = 'This IP Address has reached the time limit for this method';//todo translate $lang['text_rest_unknown_method'] = 'Άγνωστη μέθοδος'; $lang['text_rest_unsupported'] = 'Το συγκεκριμένο πρωτόκολλο δεν υποστηρίζεται'; diff --git a/application/language/portuguese-brazilian/rest_controller_lang.php b/application/language/portuguese-brazilian/rest_controller_lang.php index 04bbf6e3..84dc9e0e 100644 --- a/application/language/portuguese-brazilian/rest_controller_lang.php +++ b/application/language/portuguese-brazilian/rest_controller_lang.php @@ -13,5 +13,6 @@ $lang['text_rest_api_key_unauthorized'] = 'Esta chave da API não tem acesso ao controller solicitado'; $lang['text_rest_api_key_permissions'] = 'Esta chave da API não tem permissões suficientes'; $lang['text_rest_api_key_time_limit'] = 'Esta chave da API já atingiu o tempo limite para este método'; +$lang['text_rest_ip_address_time_limit'] = 'This IP Address has reached the time limit for this method';//todo translate $lang['text_rest_unknown_method'] = 'Método desconhecido'; $lang['text_rest_unsupported'] = 'Sem suporte para este protocolo'; diff --git a/application/language/romanian/rest_controller_lang.php b/application/language/romanian/rest_controller_lang.php index c7b94478..f151d527 100644 --- a/application/language/romanian/rest_controller_lang.php +++ b/application/language/romanian/rest_controller_lang.php @@ -13,5 +13,6 @@ $lang['text_rest_api_key_unauthorized'] = 'Această cheie API nu are acees la controller-ul solicitat'; $lang['text_rest_api_key_permissions'] = 'Această cheie API nu are suficiente permisiuni'; $lang['text_rest_api_key_time_limit'] = 'Această cheie API a atins limita de timp pentru această metodă'; +$lang['text_rest_ip_address_time_limit'] = 'This IP Address has reached the time limit for this method';//todo translate $lang['text_rest_unknown_method'] = 'Metodă necunoscută'; $lang['text_rest_unsupported'] = 'Protocol neacceptat'; diff --git a/application/language/serbian_cyr/rest_controller_lang.php b/application/language/serbian_cyr/rest_controller_lang.php index e2164214..4d249c49 100644 --- a/application/language/serbian_cyr/rest_controller_lang.php +++ b/application/language/serbian_cyr/rest_controller_lang.php @@ -13,5 +13,6 @@ $lang['text_rest_api_key_unauthorized'] = 'Овај *API* кључ нема овлашћења за захтевани контролер'; $lang['text_rest_api_key_permissions'] = 'Овај *API* кључ нема дозвољен степен овлашћења'; $lang['text_rest_api_key_time_limit'] = 'Овај *API* кључ је прекорачио временски лимит за дати метод'; +$lang['text_rest_ip_address_time_limit'] = 'This IP Address has reached the time limit for this method';//todo translate $lang['text_rest_unknown_method'] = 'Непознат метод'; $lang['text_rest_unsupported'] = 'Неподржан протокол'; diff --git a/application/language/serbian_lat/rest_controller_lang.php b/application/language/serbian_lat/rest_controller_lang.php index 4b6b749f..057ab930 100644 --- a/application/language/serbian_lat/rest_controller_lang.php +++ b/application/language/serbian_lat/rest_controller_lang.php @@ -13,5 +13,6 @@ $lang['text_rest_api_key_unauthorized'] = 'Ovaj API ključ nema ovlašćenje za zahtevani kontroler'; $lang['text_rest_api_key_permissions'] = 'Ovaj API ključ nema dozvoljen stepen ovlašćenja'; $lang['text_rest_api_key_time_limit'] = 'Ovaj API ključ je prekoračio vremenski limit za dati metod'; +$lang['text_rest_ip_address_time_limit'] = 'This IP Address has reached the time limit for this method';//todo translate $lang['text_rest_unknown_method'] = 'Nepoznat metod'; $lang['text_rest_unsupported'] = 'Nepodržan protokol'; diff --git a/application/language/simplified-chinese/rest_controller_lang.php b/application/language/simplified-chinese/rest_controller_lang.php index f7f19fb1..f32e9e7d 100644 --- a/application/language/simplified-chinese/rest_controller_lang.php +++ b/application/language/simplified-chinese/rest_controller_lang.php @@ -13,5 +13,6 @@ $lang['text_rest_api_key_unauthorized'] = '此 API key无法存取指定的 controller'; $lang['text_rest_api_key_permissions'] = '此 API key没有足够的权限'; $lang['text_rest_api_key_time_limit'] = '此 API key已经超过有效期限'; +$lang['text_rest_ip_address_time_limit'] = 'This IP Address has reached the time limit for this method';//todo translate $lang['text_rest_unknown_method'] = '未知的方法'; $lang['text_rest_unsupported'] = '不支持的请求方法'; diff --git a/application/language/spanish/rest_controller_lang.php b/application/language/spanish/rest_controller_lang.php index b6dea8fb..2ca81056 100644 --- a/application/language/spanish/rest_controller_lang.php +++ b/application/language/spanish/rest_controller_lang.php @@ -13,5 +13,6 @@ $lang['text_rest_api_key_unauthorized'] = 'Esta clave de API no tiene acceso al controlador solicitado'; $lang['text_rest_api_key_permissions'] = 'Esta clave de API no tiene suficientes permisos'; $lang['text_rest_api_key_time_limit'] = 'Esta clave de API ha alcanzado el límite de tiempo para este método'; +$lang['text_rest_ip_address_time_limit'] = 'This IP Address has reached the time limit for this method';//todo translate $lang['text_rest_unknown_method'] = 'método desconocido'; $lang['text_rest_unsupported'] = 'Protocolo no soportado'; diff --git a/application/language/traditional-chinese/rest_controller_lang.php b/application/language/traditional-chinese/rest_controller_lang.php index f388c446..b1f80caf 100644 --- a/application/language/traditional-chinese/rest_controller_lang.php +++ b/application/language/traditional-chinese/rest_controller_lang.php @@ -13,5 +13,6 @@ $lang['text_rest_api_key_unauthorized'] = '這個 API 金鑰沒有辦法存取指定的 controller'; $lang['text_rest_api_key_permissions'] = '這個 API 金鑰沒有具備足夠權限'; $lang['text_rest_api_key_time_limit'] = '這個 API 金鑰已經超過有效期限'; +$lang['text_rest_ip_address_time_limit'] = 'This IP Address has reached the time limit for this method';//todo translate $lang['text_rest_unknown_method'] = '未知的方法'; $lang['text_rest_unsupported'] = '不支援的通訊協定'; diff --git a/application/language/turkish/rest_controller_lang.php b/application/language/turkish/rest_controller_lang.php index 2efcd2c8..589b28cc 100644 --- a/application/language/turkish/rest_controller_lang.php +++ b/application/language/turkish/rest_controller_lang.php @@ -13,5 +13,6 @@ $lang['text_rest_api_key_unauthorized'] = 'Ulaşılmak istenilen controllera API anahtarının erişim yetkisi bulunmamaktadır'; $lang['text_rest_api_key_permissions'] = 'Bu API anahtarının yeterli yetkisi bulunmamaktadır'; $lang['text_rest_api_key_time_limit'] = 'API anahtarı bu metod için zaman sınırına ulaştı.'; +$lang['text_rest_ip_address_time_limit'] = 'IP adresi bu metod için zaman sınırına ulaştı.'; $lang['text_rest_unknown_method'] = 'Bilinmeyen metod'; $lang['text_rest_unsupported'] = 'Desteklenmeyen protokol'; diff --git a/application/libraries/REST_Controller.php b/application/libraries/REST_Controller.php index 81be0a22..45ceb5ed 100644 --- a/application/libraries/REST_Controller.php +++ b/application/libraries/REST_Controller.php @@ -704,6 +704,13 @@ public function _remap($object_called, $arguments = []) } } + //check request limit by ip without login + elseif ($this->config->item('rest_limits_method') == "IP_ADDRESS" && $this->config->item('rest_enable_limits') && $this->_check_limit($controller_method) === FALSE) + { + $response = [$this->config->item('rest_status_field_name') => FALSE, $this->config->item('rest_message_field_name') => $this->lang->line('text_rest_ip_address_time_limit')]; + $this->response($response, self::HTTP_UNAUTHORIZED); + } + // No key stuff, but record that stuff is happening elseif ($this->config->item('rest_enable_logging') && $log_method) { @@ -1129,10 +1136,17 @@ protected function _check_limit($controller_method) return TRUE; } + $api_key = isset($this->rest->key) ? $this->rest->key : ''; + switch ($this->config->item('rest_limits_method')) { + case 'IP_ADDRESS': + $limited_uri = 'ip-address:' .$this->input->ip_address(); + $api_key = $this->input->ip_address(); + break; + case 'API_KEY': - $limited_uri = 'api-key:' . (isset($this->rest->key) ? $this->rest->key : ''); + $limited_uri = 'api-key:' . $api_key; break; case 'METHOD_NAME': @@ -1164,7 +1178,7 @@ protected function _check_limit($controller_method) // Get data about a keys' usage and limit to one row $result = $this->rest->db ->where('uri', $limited_uri) - ->where('api_key', $this->rest->key) + ->where('api_key', $api_key) ->get($this->config->item('rest_limits_table')) ->row(); @@ -1174,7 +1188,7 @@ protected function _check_limit($controller_method) // Create a new row for the following key $this->rest->db->insert($this->config->item('rest_limits_table'), [ 'uri' => $limited_uri, - 'api_key' => isset($this->rest->key) ? $this->rest->key : '', + 'api_key' =>$api_key, 'count' => 1, 'hour_started' => time() ]); @@ -1186,7 +1200,7 @@ protected function _check_limit($controller_method) // Reset the started period and count $this->rest->db ->where('uri', $limited_uri) - ->where('api_key', isset($this->rest->key) ? $this->rest->key : '') + ->where('api_key', $api_key) ->set('hour_started', time()) ->set('count', 1) ->update($this->config->item('rest_limits_table')); @@ -1204,7 +1218,7 @@ protected function _check_limit($controller_method) // Increase the count by one $this->rest->db ->where('uri', $limited_uri) - ->where('api_key', $this->rest->key) + ->where('api_key', $api_key) ->set('count', 'count + 1', FALSE) ->update($this->config->item('rest_limits_table')); } From 929b0f5ef68a52e4bc639da662af24c629aae74a Mon Sep 17 00:00:00 2001 From: Ties Kuypers Date: Wed, 26 Oct 2016 15:51:57 +0200 Subject: [PATCH 018/129] added dutch translation (#721) * Added dutch language * Create index.html --- application/language/dutch/index.html | 11 +++++++++++ .../language/dutch/rest_controller_lang.php | 16 ++++++++++++++++ 2 files changed, 27 insertions(+) create mode 100644 application/language/dutch/index.html create mode 100644 application/language/dutch/rest_controller_lang.php diff --git a/application/language/dutch/index.html b/application/language/dutch/index.html new file mode 100644 index 00000000..b702fbc3 --- /dev/null +++ b/application/language/dutch/index.html @@ -0,0 +1,11 @@ + + + + 403 Forbidden + + + +

Directory access is forbidden.

+ + + diff --git a/application/language/dutch/rest_controller_lang.php b/application/language/dutch/rest_controller_lang.php new file mode 100644 index 00000000..182ca61c --- /dev/null +++ b/application/language/dutch/rest_controller_lang.php @@ -0,0 +1,16 @@ + Date: Wed, 26 Oct 2016 16:52:42 +0300 Subject: [PATCH 019/129] Bulgarian language update. (#719) Signed-off-by:Ivan Tcholakov --- application/language/bulgarian/rest_controller_lang.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/application/language/bulgarian/rest_controller_lang.php b/application/language/bulgarian/rest_controller_lang.php index 1dec8515..4ba134d8 100644 --- a/application/language/bulgarian/rest_controller_lang.php +++ b/application/language/bulgarian/rest_controller_lang.php @@ -13,6 +13,6 @@ $lang['text_rest_api_key_unauthorized'] = 'API ключът не е оторизиран зо достъп до заявения контролер'; $lang['text_rest_api_key_permissions'] = 'API ключът няма достатъчно права'; $lang['text_rest_api_key_time_limit'] = 'API ключът е изполван с превишаване на времевия лимит за този метод'; -$lang['text_rest_ip_address_time_limit'] = 'This IP Address has reached the time limit for this method';//todo translate +$lang['text_rest_ip_address_time_limit'] = 'За текущия IP адрес е превишен времевия лимит за изпълнение на метода'; $lang['text_rest_unknown_method'] = 'Неизвестен метод'; $lang['text_rest_unsupported'] = 'Неподдържан протокол'; From 73eaa18822473acadcc65ca8ffb10c7b60f54de9 Mon Sep 17 00:00:00 2001 From: Barayuda Gautama Date: Wed, 23 Nov 2016 00:08:54 +0800 Subject: [PATCH 020/129] Add Indonesian language (#723) --- application/language/indonesia/index.html | 11 +++++++++++ .../indonesia/rest_controller_lang.php | 18 ++++++++++++++++++ 2 files changed, 29 insertions(+) create mode 100644 application/language/indonesia/index.html create mode 100644 application/language/indonesia/rest_controller_lang.php diff --git a/application/language/indonesia/index.html b/application/language/indonesia/index.html new file mode 100644 index 00000000..b702fbc3 --- /dev/null +++ b/application/language/indonesia/index.html @@ -0,0 +1,11 @@ + + + + 403 Forbidden + + + +

Directory access is forbidden.

+ + + diff --git a/application/language/indonesia/rest_controller_lang.php b/application/language/indonesia/rest_controller_lang.php new file mode 100644 index 00000000..771c6835 --- /dev/null +++ b/application/language/indonesia/rest_controller_lang.php @@ -0,0 +1,18 @@ + Date: Tue, 22 Nov 2016 18:09:56 +0200 Subject: [PATCH 021/129] Code smell, PHP Doc problems, Index methods, and global exception handler (#726) * Fixed throws statement * Removed unnecessary return doc * Fixed wrong return value * Fixed parameter types in PHP DOC * Removed paths inspection in the project * Added index methods support! Finally * Handle all exceptions showings in one place. not 2 * Added changes to the change log --- .gitignore | 3 ++- CHANGELOG.md | 4 ++++ application/controllers/api/Example.php | 1 + application/controllers/api/Key.php | 1 + application/libraries/Format.php | 10 +++++----- application/libraries/REST_Controller.php | 17 ++++++++--------- 6 files changed, 21 insertions(+), 15 deletions(-) diff --git a/.gitignore b/.gitignore index 47f36f65..a761a8b8 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ .DS_Store -vendor \ No newline at end of file +vendor +.idea \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index dfdadc58..e22c03ed 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,10 @@ Changelog: =========== +### UNRELEASED +* Added support for CodeIgniter controller's index methods (index_GET, index_POST...) +* Added exceptions handling when the method could not be found + ### 2.7.2 * Added $this->query() in which query parameters can now be obtained regardless of whether a GET request is sent or not diff --git a/application/controllers/api/Example.php b/application/controllers/api/Example.php index 2f8f9e7a..b571e74d 100644 --- a/application/controllers/api/Example.php +++ b/application/controllers/api/Example.php @@ -3,6 +3,7 @@ defined('BASEPATH') OR exit('No direct script access allowed'); // This can be removed if you use __autoload() in config.php OR use Modular Extensions +/** @noinspection PhpIncludeInspection */ require APPPATH . '/libraries/REST_Controller.php'; /** diff --git a/application/controllers/api/Key.php b/application/controllers/api/Key.php index 0fa67172..35d7c0f7 100644 --- a/application/controllers/api/Key.php +++ b/application/controllers/api/Key.php @@ -3,6 +3,7 @@ defined('BASEPATH') OR exit('No direct script access allowed'); // This can be removed if you use __autoload() in config.php OR use Modular Extensions +/** @noinspection PhpIncludeInspection */ require APPPATH . '/libraries/REST_Controller.php'; /** diff --git a/application/libraries/Format.php b/application/libraries/Format.php index d078298c..a6e2cf98 100644 --- a/application/libraries/Format.php +++ b/application/libraries/Format.php @@ -461,8 +461,8 @@ public function to_php($data = NULL) // INTERNAL FUNCTIONS /** - * @param $data XML string - * @return SimpleXMLElement XML element object; otherwise, empty array + * @param string $data XML string + * @return array XML element object; otherwise, empty array */ protected function _from_xml($data) { @@ -496,7 +496,7 @@ protected function _from_csv($data, $delimiter = ',', $enclosure = '"') } /** - * @param $data Encoded json string + * @param string $data Encoded json string * @return mixed Decoded json string with leading and trailing whitespace removed */ protected function _from_json($data) @@ -505,7 +505,7 @@ protected function _from_json($data) } /** - * @param string Data to unserialized + * @param string $data Data to unserialize * @return mixed Unserialized data */ protected function _from_serialize($data) @@ -514,7 +514,7 @@ protected function _from_serialize($data) } /** - * @param $data Data to trim leading and trailing whitespace + * @param string $data Data to trim leading and trailing whitespace * @return string Data with leading and trailing whitespace removed */ protected function _from_php($data) diff --git a/application/libraries/REST_Controller.php b/application/libraries/REST_Controller.php index 45ceb5ed..17f81375 100644 --- a/application/libraries/REST_Controller.php +++ b/application/libraries/REST_Controller.php @@ -375,7 +375,6 @@ protected function early_checks() * @access public * @param string $config Configuration filename minus the file extension * e.g: my_rest.php is passed as 'my_rest' - * @return void */ public function __construct($config = 'rest') { @@ -590,7 +589,7 @@ public function __destruct() * Checks to see if we have everything we need to run this library. * * @access protected - * @return Exception + * @@throws Exception */ protected function preflight_checks() { @@ -632,6 +631,11 @@ public function _remap($object_called, $arguments = []) $object_called = preg_replace('/^(.*)\.(?:'.implode('|', array_keys($this->_supported_formats)).')$/', '$1', $object_called); $controller_method = $object_called.'_'.$this->request->method; + // Does this method exist? If not, try executing an index method + if (!method_exists($this, $controller_method)) { + $controller_method = "index_" . $this->request->method; + array_unshift($arguments, $object_called); + } // Do we want to log this method (if allowed by config)? $log_method = ! (isset($this->methods[$controller_method]['log']) && $this->methods[$controller_method]['log'] === FALSE); @@ -725,13 +729,8 @@ public function _remap($object_called, $arguments = []) catch (Exception $ex) { // If the method doesn't exist, then the error will be caught and an error response shown - $this->response([ - $this->config->item('rest_status_field_name') => FALSE, - $this->config->item('rest_message_field_name') => [ - 'classname' => get_class($ex), - 'message' => $ex->getMessage() - ] - ], self::HTTP_INTERNAL_SERVER_ERROR); + $_error = &load_class('Exceptions', 'core'); + $_error->show_exception($ex); } } From dfb0a4f5802cbc8bc4e55f09a6cfca877fa125a3 Mon Sep 17 00:00:00 2001 From: SC Date: Tue, 22 Nov 2016 17:10:56 +0100 Subject: [PATCH 022/129] Add italian language (#733) * added italian translation * Create index.html --- application/language/italian/index.html | 11 +++++++++++ .../language/italian/rest_controller_lang.php | 16 ++++++++++++++++ 2 files changed, 27 insertions(+) create mode 100644 application/language/italian/index.html create mode 100644 application/language/italian/rest_controller_lang.php diff --git a/application/language/italian/index.html b/application/language/italian/index.html new file mode 100644 index 00000000..b702fbc3 --- /dev/null +++ b/application/language/italian/index.html @@ -0,0 +1,11 @@ + + + + 403 Forbidden + + + +

Directory access is forbidden.

+ + + diff --git a/application/language/italian/rest_controller_lang.php b/application/language/italian/rest_controller_lang.php new file mode 100644 index 00000000..783f16ab --- /dev/null +++ b/application/language/italian/rest_controller_lang.php @@ -0,0 +1,16 @@ + Date: Tue, 22 Nov 2016 17:11:15 +0100 Subject: [PATCH 023/129] response continue fix (#722) --- application/libraries/REST_Controller.php | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/application/libraries/REST_Controller.php b/application/libraries/REST_Controller.php index 17f81375..d7a691da 100644 --- a/application/libraries/REST_Controller.php +++ b/application/libraries/REST_Controller.php @@ -745,6 +745,7 @@ public function _remap($object_called, $arguments = []) */ public function response($data = NULL, $http_code = NULL, $continue = FALSE) { + ob_start(); // If the HTTP status is not NULL, then cast as an integer if ($http_code !== NULL) { @@ -813,6 +814,10 @@ public function response($data = NULL, $http_code = NULL, $continue = FALSE) $this->output->_display(); exit; } + else + { + ob_end_flush(); + } // Otherwise dump the output automatically } From d19dc77f03521c7a725a4555407e1e4e7a85f6e1 Mon Sep 17 00:00:00 2001 From: Ian Lin Date: Wed, 23 Nov 2016 00:11:35 +0800 Subject: [PATCH 024/129] fix cross site to option request error (#720) cross site request first can use option http method. but use `keys` authentication, authentication can fail --- application/libraries/REST_Controller.php | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/application/libraries/REST_Controller.php b/application/libraries/REST_Controller.php index d7a691da..1f0374a0 100644 --- a/application/libraries/REST_Controller.php +++ b/application/libraries/REST_Controller.php @@ -650,6 +650,11 @@ public function _remap($object_called, $arguments = []) { $this->_log_request(); } + + // fix cross site to option request error + if($this->request->method == 'options') { + exit; + } $this->response([ $this->config->item('rest_status_field_name') => FALSE, From d8a6cbb1d8991859f89dc57222afaacb1de7e082 Mon Sep 17 00:00:00 2001 From: Amit Moryossef Date: Wed, 21 Dec 2016 16:26:17 +0200 Subject: [PATCH 025/129] All around cleaning (#734) * Fixed throws statement * Removed unnecessary return doc * Fixed wrong return value * Fixed parameter types in PHP DOC * Removed paths inspection in the project * Added index methods support! Finally * Handle all exceptions showings in one place. not 2 * Added changes to the change log * Fixed properties PHPDoc * English spelling fixes --- CHANGELOG.md | 6 +++--- README.md | 6 +++--- application/config/rest.php | 20 ++++++++++---------- application/controllers/api/Example.php | 2 +- application/libraries/REST_Controller.php | 18 +++++++++--------- 5 files changed, 26 insertions(+), 26 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e22c03ed..ce83aeda 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -38,7 +38,7 @@ Changelog: * Log Table support for IPv6 & NULL parameters * Abstract out the processes of firing a controller method within _remap() to an separate method * Moved GET, POST, PUT, and DELETE parsing to separate methods, allowing them to be overridden as needed -* Small bugfix for a PHP 5.3 strlen error +* Small bug-fix for a PHP 5.3 strlen error * Fixed some PHP 5.4 warnings * Fix for bug in Format.php's to_html() which failed to detect if $data was really a multidimensional array. * Fix for empty node on XML output format, for false = 0, true = 1. @@ -55,11 +55,11 @@ Changelog: * Support for Backbone.emulateHTTP improved. * Combine both URI segment and GET params instead of using one or the other * Separate each piece of the WWW-Authenticate header for digest requests with a comma. -* Added IP whitelist option. +* Added IP white-list option. ### 2.5 -* Instead of just seeing item, item, item, the singular version of the basenode will be used if possible. [Example](http://d.pr/RS46). +* Instead of just seeing item, item, item, the singular version of the base-node will be used if possible. [Example](http://d.pr/RS46). * Re-factored to use the Format library, which will soon be merged with CodeIgniter. * Fixed Limit bug (limit of 5 would allow 6 requests). * Added logging for invalid API key requests. diff --git a/README.md b/README.md index b33b448a..4b212f4e 100644 --- a/README.md +++ b/README.md @@ -150,9 +150,9 @@ Enabling digest auth is similarly easy. Configure your desired logins in the con If you're tying this library into an AJAX endpoint where clients authenticate using PHP sessions then you may not like either of the digest nor basic authentication methods. In that case, you can tell the REST Library what PHP session variable to check for. If the variable exists, then the user is authorized. It will be up to your application to set that variable. You can define the variable in ``$config['auth_source']``. Then tell the library to use a php session variable by setting ``$config['rest_auth']`` to ``session``. -All three methods of authentication can be secured further by using an IP whitelist. If you enable `$config['rest_ip_whitelist_enabled']` in your config file, you can then set a list of allowed IPs. +All three methods of authentication can be secured further by using an IP white-list. If you enable `$config['rest_ip_whitelist_enabled']` in your config file, you can then set a list of allowed IPs. -Any client connecting to your API will be checked against the whitelisted IP array. If they're on the list, they'll be allowed access. If not, sorry, no can do hombre. The whitelist is a comma-separated string: +Any client connecting to your API will be checked against the white-listed IP array. If they're on the list, they'll be allowed access. If not, sorry, no can do hombre. The whitelist is a comma-separated string: ```php $config['rest_ip_whitelist'] = '123.456.789.0, 987.654.32.1'; @@ -196,7 +196,7 @@ $ curl -X POST -H "X-API-KEY: some_key_here" http://example.com/books ## Contributions This project was originally written by Phil Sturgeon, however his involvement has shifted -as he is no longer using it. As of 2013/11/20 further developement and support will be done by Chris Kacerguis. +as he is no longer using it. As of 2013/11/20 further development and support will be done by Chris Kacerguis. Pull Requests are the best way to fix bugs or add features. I know loads of you use this, so please contribute if you have improvements to be made and I'll keep releasing versions over time. diff --git a/application/config/rest.php b/application/config/rest.php index 95ddc5cf..f49b751d 100644 --- a/application/config/rest.php +++ b/application/config/rest.php @@ -104,8 +104,8 @@ | Set to specify the REST API requires to be logged in | | FALSE No login required -| 'basic' Unsecure login -| 'digest' More secure login +| 'basic' Unsecured login +| 'digest' More secured login | 'session' Check for a PHP session variable. See 'auth_source' to set the | authorization key | @@ -189,7 +189,7 @@ /* |-------------------------------------------------------------------------- -| Override auth types for specfic 'class/method/HTTP method' +| Override auth types for specific 'class/method/HTTP method' |-------------------------------------------------------------------------- | | example: @@ -214,24 +214,24 @@ /* |-------------------------------------------------------------------------- -| Global IP Whitelisting +| Global IP White-listing |-------------------------------------------------------------------------- | -| Limit connections to your REST server to whitelisted IP addresses +| Limit connections to your REST server to White-listed IP addresses | | Usage: | 1. Set to TRUE and select an auth option for extreme security (client's IP -| address must be in whitelist and they must also log in) -| 2. Set to TRUE with auth set to FALSE to allow whitelisted IPs access with no login -| 3. Set to FALSE but set 'auth_override_class_method' to 'whitelist' to -| restrict certain methods to IPs in your whitelist +| address must be in white-list and they must also log in) +| 2. Set to TRUE with auth set to FALSE to allow White-listed IPs access with no login +| 3. Set to FALSE but set 'auth_override_class_method' to 'white-list' to +| restrict certain methods to IPs in your white-list | */ $config['rest_ip_whitelist_enabled'] = FALSE; /* |-------------------------------------------------------------------------- -| REST IP Whitelist +| REST IP White-list |-------------------------------------------------------------------------- | | Limit connections to your REST server with a comma separated diff --git a/application/controllers/api/Example.php b/application/controllers/api/Example.php index b571e74d..7aef773a 100644 --- a/application/controllers/api/Example.php +++ b/application/controllers/api/Example.php @@ -73,7 +73,7 @@ public function users_get() $this->response(NULL, REST_Controller::HTTP_BAD_REQUEST); // BAD_REQUEST (400) being the HTTP response code } - // Get the user from the array, using the id as key for retreival. + // Get the user from the array, using the id as key for retrieval. // Usually a model is to be used for this. $user = NULL; diff --git a/application/libraries/REST_Controller.php b/application/libraries/REST_Controller.php index 1f0374a0..1c0fb179 100644 --- a/application/libraries/REST_Controller.php +++ b/application/libraries/REST_Controller.php @@ -285,16 +285,16 @@ abstract class REST_Controller extends CI_Controller { /** * The start of the response time from the server * - * @var string + * @var number */ - protected $_start_rtime = ''; + protected $_start_rtime; /** * The end of the response time from the server * - * @var string + * @var number */ - protected $_end_rtime = ''; + protected $_end_rtime; /** * List all supported methods, the first will be the default format @@ -567,7 +567,7 @@ public function __construct($config = 'rest') } /** - * Deconstructor + * De-constructor * * @author Chris Kacerguis * @access public @@ -778,7 +778,7 @@ public function response($data = NULL, $http_code = NULL, $continue = FALSE) $output = $this->format->factory($data)->{'to_' . $this->response->format}(); // An array must be parsed as a string, so as not to cause an array to string error - // Json is the most appropriate form for such a datatype + // Json is the most appropriate form for such a data type if ($this->response->format === 'array') { $output = $this->format->factory($output)->{'to_json'}(); @@ -1473,7 +1473,7 @@ protected function _parse_put() } else if ($this->input->method() === 'put') { - // If no filetype is provided, then there are probably just arguments + // If no file type is provided, then there are probably just arguments $this->_put_args = $this->input->input_stream(); } } @@ -1523,7 +1523,7 @@ protected function _parse_patch() } else if ($this->input->method() === 'patch') { - // If no filetype is provided, then there are probably just arguments + // If no file type is provided, then there are probably just arguments $this->_patch_args = $this->input->input_stream(); } } @@ -1941,7 +1941,7 @@ protected function _check_php_session() // Get the auth_source config item $key = $this->config->item('auth_source'); - // If falsy, then the user isn't logged in + // If false, then the user isn't logged in if ( ! $this->session->userdata($key)) { // Display an error response From e1cbdc1848b07b66a1328fdba2e4b39c5df80426 Mon Sep 17 00:00:00 2001 From: kiss7001 Date: Wed, 21 Dec 2016 23:26:55 +0900 Subject: [PATCH 026/129] bug fix (#735) --- application/controllers/api/Key.php | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/application/controllers/api/Key.php b/application/controllers/api/Key.php index 35d7c0f7..547334b6 100644 --- a/application/controllers/api/Key.php +++ b/application/controllers/api/Key.php @@ -233,7 +233,7 @@ private function _generate_key() private function _get_key($key) { - return $this->db + return $this->rest->db ->where(config_item('rest_key_column'), $key) ->get(config_item('rest_keys_table')) ->row(); @@ -241,7 +241,7 @@ private function _get_key($key) private function _key_exists($key) { - return $this->db + return $this->rest->db ->where(config_item('rest_key_column'), $key) ->count_all_results(config_item('rest_keys_table')) > 0; } @@ -251,21 +251,21 @@ private function _insert_key($key, $data) $data[config_item('rest_key_column')] = $key; $data['date_created'] = function_exists('now') ? now() : time(); - return $this->db + return $this->rest->db ->set($data) ->insert(config_item('rest_keys_table')); } private function _update_key($key, $data) { - return $this->db + return $this->rest->db ->where(config_item('rest_key_column'), $key) ->update(config_item('rest_keys_table'), $data); } private function _delete_key($key) { - return $this->db + return $this->rest->db ->where(config_item('rest_key_column'), $key) ->delete(config_item('rest_keys_table')); } From 7e1c22c3b2601ca03a885dd34365ef8b7e7fb1b3 Mon Sep 17 00:00:00 2001 From: Ian Lin Date: Wed, 21 Dec 2016 22:29:44 +0800 Subject: [PATCH 027/129] Fix parse method return arguments null (#744) * fix cross site to option request error cross site request first can use option http method. but use `keys` authentication, authentication can fail * Fix Parse error Fix parse method return arguments null --- application/libraries/REST_Controller.php | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/application/libraries/REST_Controller.php b/application/libraries/REST_Controller.php index 1c0fb179..bc9e750f 100644 --- a/application/libraries/REST_Controller.php +++ b/application/libraries/REST_Controller.php @@ -475,6 +475,12 @@ public function __construct($config = 'rest') $this->request->body = NULL; $this->{'_parse_' . $this->request->method}(); + + // Fix parse method return arguments null + if($this->{'_'.$this->request->method.'_args'} === null) + { + $this->{'_'.$this->request->method.'_args'} = []; + } // Now we know all about our request, let's try and parse the body if it exists if ($this->request->format && $this->request->body) From a36e4728114a53d4639dc8a5da27da11b3c43249 Mon Sep 17 00:00:00 2001 From: lweb20 Date: Mon, 26 Dec 2016 20:35:16 -0500 Subject: [PATCH 028/129] Add config to handle or not exceptions (#739) --- application/config/rest.php | 10 ++++++++++ application/libraries/REST_Controller.php | 6 +++++- 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/application/config/rest.php b/application/config/rest.php index f49b751d..deafeeb7 100644 --- a/application/config/rest.php +++ b/application/config/rest.php @@ -229,6 +229,16 @@ */ $config['rest_ip_whitelist_enabled'] = FALSE; +/* +|-------------------------------------------------------------------------- +| REST Handle Exceptions +|-------------------------------------------------------------------------- +| +| Handle exceptions caused by the controller +| +*/ +$config['rest_handle_exceptions'] = TRUE; + /* |-------------------------------------------------------------------------- | REST IP White-list diff --git a/application/libraries/REST_Controller.php b/application/libraries/REST_Controller.php index bc9e750f..442046a1 100644 --- a/application/libraries/REST_Controller.php +++ b/application/libraries/REST_Controller.php @@ -595,7 +595,7 @@ public function __destruct() * Checks to see if we have everything we need to run this library. * * @access protected - * @@throws Exception + * @throws Exception */ protected function preflight_checks() { @@ -739,6 +739,10 @@ public function _remap($object_called, $arguments = []) } catch (Exception $ex) { + if ($this->config->item('rest_handle_exceptions') === FALSE) { + throw $ex; + } + // If the method doesn't exist, then the error will be caught and an error response shown $_error = &load_class('Exceptions', 'core'); $_error->show_exception($ex); From 5aef7b41bb08de33bcd892cc2d6e1276a5338722 Mon Sep 17 00:00:00 2001 From: Chris Kacerguis Date: Mon, 26 Dec 2016 19:40:44 -0600 Subject: [PATCH 029/129] added gitter badge --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 4b212f4e..8943a5ce 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # CodeIgniter Rest Server +[![Gitter chat](https://badges.gitter.im/chriskacerguis/codeigniter-restserver.png)](https://gitter.im/codeigniter-restserver/Lobby) + A fully RESTful server implementation for CodeIgniter using one library, one config file and one controller. From 859eb0156ca92ca55adf3baf09968b34bb8016cd Mon Sep 17 00:00:00 2001 From: Himphen Hui Date: Sat, 24 Jun 2017 07:51:13 +0800 Subject: [PATCH 030/129] Update rest_controller_lang.php (#799) --- .../language/traditional-chinese/rest_controller_lang.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/application/language/traditional-chinese/rest_controller_lang.php b/application/language/traditional-chinese/rest_controller_lang.php index b1f80caf..a8450f2b 100644 --- a/application/language/traditional-chinese/rest_controller_lang.php +++ b/application/language/traditional-chinese/rest_controller_lang.php @@ -13,6 +13,6 @@ $lang['text_rest_api_key_unauthorized'] = '這個 API 金鑰沒有辦法存取指定的 controller'; $lang['text_rest_api_key_permissions'] = '這個 API 金鑰沒有具備足夠權限'; $lang['text_rest_api_key_time_limit'] = '這個 API 金鑰已經超過有效期限'; -$lang['text_rest_ip_address_time_limit'] = 'This IP Address has reached the time limit for this method';//todo translate +$lang['text_rest_ip_address_time_limit'] = '這個 IP 位置的流量已經超過上限'; $lang['text_rest_unknown_method'] = '未知的方法'; $lang['text_rest_unsupported'] = '不支援的通訊協定'; From a5eda57900ac5fc37a2691e42d4b6147af95fa1c Mon Sep 17 00:00:00 2001 From: Reinhard Date: Sat, 24 Jun 2017 01:51:38 +0200 Subject: [PATCH 031/129] Insert comma's and then a space. (#800) Inserting a space first and then a comma seems wrong to me. Was this intended? --- application/libraries/REST_Controller.php | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/application/libraries/REST_Controller.php b/application/libraries/REST_Controller.php index 442046a1..d5c2b4f0 100644 --- a/application/libraries/REST_Controller.php +++ b/application/libraries/REST_Controller.php @@ -2229,8 +2229,8 @@ protected function _check_access() protected function _check_cors() { // Convert the config items into strings - $allowed_headers = implode(' ,', $this->config->item('allowed_cors_headers')); - $allowed_methods = implode(' ,', $this->config->item('allowed_cors_methods')); + $allowed_headers = implode(', ', $this->config->item('allowed_cors_headers')); + $allowed_methods = implode(', ', $this->config->item('allowed_cors_methods')); // If we want to allow any domain to access the API if ($this->config->item('allow_any_cors_domain') === TRUE) From 4443857630df2dc1c284e5d3c8e0967d9a004061 Mon Sep 17 00:00:00 2001 From: Goran Grbic Date: Sat, 24 Jun 2017 01:52:04 +0200 Subject: [PATCH 032/129] Additional translation set (#808) * Additional translation set * APPPATH const variable already finishes with trailing slash --- application/controllers/api/Example.php | 2 +- application/language/serbian_cyr/rest_controller_lang.php | 2 +- application/language/serbian_lat/rest_controller_lang.php | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/application/controllers/api/Example.php b/application/controllers/api/Example.php index 7aef773a..eb2f9069 100644 --- a/application/controllers/api/Example.php +++ b/application/controllers/api/Example.php @@ -4,7 +4,7 @@ // This can be removed if you use __autoload() in config.php OR use Modular Extensions /** @noinspection PhpIncludeInspection */ -require APPPATH . '/libraries/REST_Controller.php'; +require APPPATH . 'libraries/REST_Controller.php'; /** * This is an example of a few basic user interaction methods you could use diff --git a/application/language/serbian_cyr/rest_controller_lang.php b/application/language/serbian_cyr/rest_controller_lang.php index 4d249c49..e83ff4db 100644 --- a/application/language/serbian_cyr/rest_controller_lang.php +++ b/application/language/serbian_cyr/rest_controller_lang.php @@ -13,6 +13,6 @@ $lang['text_rest_api_key_unauthorized'] = 'Овај *API* кључ нема овлашћења за захтевани контролер'; $lang['text_rest_api_key_permissions'] = 'Овај *API* кључ нема дозвољен степен овлашћења'; $lang['text_rest_api_key_time_limit'] = 'Овај *API* кључ је прекорачио временски лимит за дати метод'; -$lang['text_rest_ip_address_time_limit'] = 'This IP Address has reached the time limit for this method';//todo translate +$lang['text_rest_ip_address_time_limit'] = 'Ова *IP* адреса је прекорачила временски лимит за дати метод';//todo translate $lang['text_rest_unknown_method'] = 'Непознат метод'; $lang['text_rest_unsupported'] = 'Неподржан протокол'; diff --git a/application/language/serbian_lat/rest_controller_lang.php b/application/language/serbian_lat/rest_controller_lang.php index 057ab930..6046788d 100644 --- a/application/language/serbian_lat/rest_controller_lang.php +++ b/application/language/serbian_lat/rest_controller_lang.php @@ -13,6 +13,6 @@ $lang['text_rest_api_key_unauthorized'] = 'Ovaj API ključ nema ovlašćenje za zahtevani kontroler'; $lang['text_rest_api_key_permissions'] = 'Ovaj API ključ nema dozvoljen stepen ovlašćenja'; $lang['text_rest_api_key_time_limit'] = 'Ovaj API ključ je prekoračio vremenski limit za dati metod'; -$lang['text_rest_ip_address_time_limit'] = 'This IP Address has reached the time limit for this method';//todo translate +$lang['text_rest_ip_address_time_limit'] = 'Ova IP adresa je prekoračila vremenski limit za dati metod'; $lang['text_rest_unknown_method'] = 'Nepoznat metod'; $lang['text_rest_unsupported'] = 'Nepodržan protokol'; From b0229a15c5caabcf485c10304fa99dde6c3e0055 Mon Sep 17 00:00:00 2001 From: Jonghwi Date: Sat, 24 Jun 2017 08:53:11 +0900 Subject: [PATCH 033/129] Korean language support (#812) * Added Korean language translation * Create default index.html --- application/language/korean/index.html | 11 +++++++++++ .../language/korean/rest_controller_lang.php | 16 ++++++++++++++++ 2 files changed, 27 insertions(+) create mode 100644 application/language/korean/index.html create mode 100644 application/language/korean/rest_controller_lang.php diff --git a/application/language/korean/index.html b/application/language/korean/index.html new file mode 100644 index 00000000..b702fbc3 --- /dev/null +++ b/application/language/korean/index.html @@ -0,0 +1,11 @@ + + + + 403 Forbidden + + + +

Directory access is forbidden.

+ + + diff --git a/application/language/korean/rest_controller_lang.php b/application/language/korean/rest_controller_lang.php new file mode 100644 index 00000000..df6f9b46 --- /dev/null +++ b/application/language/korean/rest_controller_lang.php @@ -0,0 +1,16 @@ + Date: Sun, 23 Jul 2017 17:56:35 +0300 Subject: [PATCH 034/129] Added encode conversion to to_csv-function so that special characters are shown correctly in MS Excel. (#818) --- application/libraries/Format.php | 3 +++ 1 file changed, 3 insertions(+) diff --git a/application/libraries/Format.php b/application/libraries/Format.php index a6e2cf98..b1405302 100644 --- a/application/libraries/Format.php +++ b/application/libraries/Format.php @@ -378,6 +378,9 @@ public function to_csv($data = NULL, $delimiter = ',', $enclosure = '"') // Close the handle fclose($handle); + + // Convert UTF-8 encoding to UTF-16LE which is supported by MS Excel + $csv = mb_convert_encoding($csv, 'UTF-16LE', 'UTF-8'); return $csv; } From db3eef81fb36a1457bcce79e7a57c6b37c5403be Mon Sep 17 00:00:00 2001 From: Natan Felles Date: Thu, 6 Jul 2017 18:42:20 -0300 Subject: [PATCH 035/129] Translated text_rest_ip_address_time_limit --- .../language/portuguese-brazilian/rest_controller_lang.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/application/language/portuguese-brazilian/rest_controller_lang.php b/application/language/portuguese-brazilian/rest_controller_lang.php index 84dc9e0e..10c164c6 100644 --- a/application/language/portuguese-brazilian/rest_controller_lang.php +++ b/application/language/portuguese-brazilian/rest_controller_lang.php @@ -13,6 +13,6 @@ $lang['text_rest_api_key_unauthorized'] = 'Esta chave da API não tem acesso ao controller solicitado'; $lang['text_rest_api_key_permissions'] = 'Esta chave da API não tem permissões suficientes'; $lang['text_rest_api_key_time_limit'] = 'Esta chave da API já atingiu o tempo limite para este método'; -$lang['text_rest_ip_address_time_limit'] = 'This IP Address has reached the time limit for this method';//todo translate +$lang['text_rest_ip_address_time_limit'] = 'Este Endereço IP atingiu o limite de tempo para este método'; $lang['text_rest_unknown_method'] = 'Método desconhecido'; $lang['text_rest_unsupported'] = 'Sem suporte para este protocolo'; From a2a9868a35bfec272144fd78bebe783180372603 Mon Sep 17 00:00:00 2001 From: Natan Felles Date: Sun, 23 Jul 2017 11:58:03 -0300 Subject: [PATCH 036/129] Migrations (#820) * Translated text_rest_ip_address_time_limit * Add startup Migrations and DB Helper * Revert "Translated text_rest_ip_address_time_limit" This reverts commit fa1617def0d3b918fb23d2a60c748754aa4ab863. * Add startup Migrations and DB Helper * Update users table migration --- application/helpers/db_helper.php | 69 +++++++++++++++++ application/helpers/index.html | 11 +++ .../20170706025420_create_table_users.php | 69 +++++++++++++++++ .../20170706030520_create_table_api_keys.php | 69 +++++++++++++++++ .../20170706031435_create_table_api_logs.php | 75 +++++++++++++++++++ ...20170706032133_create_table_api_access.php | 62 +++++++++++++++ ...20170706032825_create_table_api_limits.php | 57 ++++++++++++++ application/migrations/index.html | 11 +++ 8 files changed, 423 insertions(+) create mode 100755 application/helpers/db_helper.php create mode 100644 application/helpers/index.html create mode 100644 application/migrations/20170706025420_create_table_users.php create mode 100644 application/migrations/20170706030520_create_table_api_keys.php create mode 100644 application/migrations/20170706031435_create_table_api_logs.php create mode 100644 application/migrations/20170706032133_create_table_api_access.php create mode 100644 application/migrations/20170706032825_create_table_api_limits.php create mode 100644 application/migrations/index.html diff --git a/application/helpers/db_helper.php b/application/helpers/db_helper.php new file mode 100755 index 00000000..9a007a46 --- /dev/null +++ b/application/helpers/db_helper.php @@ -0,0 +1,69 @@ + + */ +defined('BASEPATH') OR exit('No direct script access allowed'); + +if ( ! function_exists('add_foreign_key')) +{ + /** + * @param string $table Table name + * @param string $foreign_key Collumn name having the Foreign Key + * @param string $references Table and column reference. Ex: users(id) + * @param string $on_delete RESTRICT, NO ACTION, CASCADE, SET NULL, SET DEFAULT + * @param string $on_update RESTRICT, NO ACTION, CASCADE, SET NULL, SET DEFAULT + * + * @return string SQL command + */ + function add_foreign_key($table, $foreign_key, $references, $on_delete = 'RESTRICT', $on_update = 'RESTRICT') + { + $references = explode('(', str_replace(')', '', str_replace('`', '', $references))); + + return "ALTER TABLE `{$table}` ADD CONSTRAINT `{$table}_{$foreign_key}_fk` FOREIGN KEY (`{$foreign_key}`) REFERENCES `{$references[0]}`(`{$references[1]}`) ON DELETE {$on_delete} ON UPDATE {$on_update}"; + } +} + +if ( ! function_exists('drop_foreign_key')) +{ + /** + * @param string $table Table name + * @param string $foreign_key Collumn name having the Foreign Key + * + * @return string SQL command + */ + function drop_foreign_key($table, $foreign_key) + { + return "ALTER TABLE `{$table}` DROP FOREIGN KEY `{$table}_{$foreign_key}_fk`"; + } +} + +if ( ! function_exists('add_trigger')) +{ + /** + * @param string $trigger_name Trigger name + * @param string $table Table name + * @param string $statement Command to run + * @param string $time BEFORE or AFTER + * @param string $event INSERT, UPDATE or DELETE + * @param string $type FOR EACH ROW [FOLLOWS|PRECEDES] + * + * @return string SQL Command + */ + function add_trigger($trigger_name, $table, $statement, $time = 'BEFORE', $event = 'INSERT', $type = 'FOR EACH ROW') + { + return 'DELIMITER ;;' . PHP_EOL . "CREATE TRIGGER `{$trigger_name}` {$time} {$event} ON `{$table}` {$type}" . PHP_EOL . 'BEGIN' . PHP_EOL . $statement . PHP_EOL . 'END;' . PHP_EOL . 'DELIMITER ;;'; + } +} + +if ( ! function_exists('drop_trigger')) +{ + /** + * @param string $trigger_name Trigger name + * + * @return string SQL Command + */ + function drop_trigger($trigger_name) + { + return "DROP TRIGGER {$trigger_name};"; + } +} diff --git a/application/helpers/index.html b/application/helpers/index.html new file mode 100644 index 00000000..b702fbc3 --- /dev/null +++ b/application/helpers/index.html @@ -0,0 +1,11 @@ + + + + 403 Forbidden + + + +

Directory access is forbidden.

+ + + diff --git a/application/migrations/20170706025420_create_table_users.php b/application/migrations/20170706025420_create_table_users.php new file mode 100644 index 00000000..aaeccb69 --- /dev/null +++ b/application/migrations/20170706025420_create_table_users.php @@ -0,0 +1,69 @@ + + */ +defined('BASEPATH') OR exit('No direct script access allowed'); + +/** + * Class Migration_create_table_users + * + * @property CI_DB_forge $dbforge + * @property CI_DB_query_builder $db + */ +class Migration_create_table_users extends CI_Migration { + + + protected $table = 'users'; + + + public function up() + { + $fields = array( + 'id' => [ + 'type' => 'INT(11)', + 'auto_increment' => TRUE, + 'unsigned' => TRUE, + ], + 'email' => [ + 'type' => 'VARCHAR(255)', + 'unique' => TRUE, + ], + 'password' => [ + 'type' => 'VARCHAR(64)', + ], + 'firstname' => [ + 'type' => 'VARCHAR(32)', + ], + 'lastname' => [ + 'type' => 'VARCHAR(32)', + ], + 'created_at' => [ + 'type' => 'DATETIME', + ], + ); + $this->dbforge->add_field($fields); + $this->dbforge->add_key('id', TRUE); + $this->dbforge->create_table($this->table, TRUE); + + /*for ($i = 1; $i <= 100; $i++) + { + $this->db->insert($this->table, [ + 'email' => "user-{$i}@mail.com", + 'password' => password_hash('codeigniter', PASSWORD_DEFAULT), + 'firstname' => "Firstname {$i}", + 'lastname' => "Lastname {$i}", + 'created_at' => date('Y-' . rand(1, 12) . '-' . rand(1, 28) . ' H:i:s'), + ]); + }*/ + } + + + public function down() + { + if ($this->db->table_exists($this->table)) + { + $this->dbforge->drop_table($this->table); + } + } + +} diff --git a/application/migrations/20170706030520_create_table_api_keys.php b/application/migrations/20170706030520_create_table_api_keys.php new file mode 100644 index 00000000..d579614d --- /dev/null +++ b/application/migrations/20170706030520_create_table_api_keys.php @@ -0,0 +1,69 @@ + + */ +defined('BASEPATH') OR exit('No direct script access allowed'); + +/** + * Class Migration_create_table_api_keys + * + * @property CI_DB_forge $dbforge + * @property CI_DB_query_builder $db + */ +class Migration_create_table_api_keys extends CI_Migration { + + + public function up() + { + $table = config_item('rest_keys_table'); + $fields = array( + 'id' => [ + 'type' => 'INT(11)', + 'auto_increment' => TRUE, + 'unsigned' => TRUE, + ], + 'user_id' => [ + 'type' => 'INT(11)', + 'unsigned' => TRUE, + ], + config_item('rest_key_column') => [ + 'type' => 'VARCHAR(' . config_item('rest_key_length') . ')', + 'unique' => TRUE, + ], + 'level' => [ + 'type' => 'INT(2)', + ], + 'ignore_limits' => [ + 'type' => 'TINYINT(1)', + 'default' => 0, + ], + 'is_private_key' => [ + 'type' => 'TINYINT(1)', + 'default' => 0, + ], + 'ip_addresses' => [ + 'type' => 'TEXT', + 'null' => TRUE, + ], + 'date_created' => [ + 'type' => 'INT(11)', + ], + ); + $this->dbforge->add_field($fields); + $this->dbforge->add_key('id', TRUE); + $this->dbforge->create_table($table); + $this->db->query(add_foreign_key($table, 'user_id', 'users(id)', 'CASCADE', 'CASCADE')); + } + + + public function down() + { + $table = config_item('rest_key_column'); + if ($this->db->table_exists($table)) + { + $this->db->query(drop_foreign_key($table, 'user_id')); + $this->dbforge->drop_table($table); + } + } + +} diff --git a/application/migrations/20170706031435_create_table_api_logs.php b/application/migrations/20170706031435_create_table_api_logs.php new file mode 100644 index 00000000..bb52b866 --- /dev/null +++ b/application/migrations/20170706031435_create_table_api_logs.php @@ -0,0 +1,75 @@ + + */ +defined('BASEPATH') OR exit('No direct script access allowed'); + +/** + * Class Migration_create_table_api_logs + * + * @property CI_DB_forge $dbforge + * @property CI_DB_query_builder $db + */ +class Migration_create_table_api_logs extends CI_Migration { + + + public function up() + { + $table = config_item('rest_logs_table'); + $fields = array( + 'id' => [ + 'type' => 'INT(11)', + 'auto_increment' => TRUE, + 'unsigned' => TRUE, + ], + 'api_key' => [ + 'type' => 'VARCHAR(' . config_item('rest_key_length') . ')', + ], + 'uri' => [ + 'type' => 'VARCHAR(255)', + ], + 'method' => [ + 'type' => 'ENUM("get","post","options","put","patch","delete")', + ], + 'params' => [ + 'type' => 'TEXT', + 'null' => TRUE, + ], + 'ip_address' => [ + 'type' => 'VARCHAR(45)', + ], + 'time' => [ + 'type' => 'INT(11)', + ], + 'rtime' => [ + 'type' => 'FLOAT', + 'null' => TRUE, + ], + 'authorized' => [ + 'type' => 'VARCHAR(1)', + ], + 'response_code' => [ + 'type' => 'SMALLINT(3)', + 'null' => TRUE, + 'default' => 0, + ], + ); + $this->dbforge->add_field($fields); + $this->dbforge->add_key('id', TRUE); + $this->dbforge->create_table($table); + /*$this->db->query(add_foreign_key($table, 'api_key', + config_item('rest_keys_table') . '(' . config_item('rest_key_column') . ')', 'CASCADE', 'CASCADE'));*/ + } + + + public function down() + { + $table = config_item('rest_logs_table'); + if ($this->db->table_exists($table)) + { + // $this->db->query(drop_foreign_key($table, 'api_key')); + $this->dbforge->drop_table($table); + } + } + +} diff --git a/application/migrations/20170706032133_create_table_api_access.php b/application/migrations/20170706032133_create_table_api_access.php new file mode 100644 index 00000000..ac863756 --- /dev/null +++ b/application/migrations/20170706032133_create_table_api_access.php @@ -0,0 +1,62 @@ + + */ +defined('BASEPATH') OR exit('No direct script access allowed'); + +/** + * Class Migration_create_table_api_access + * + * @property CI_DB_forge $dbforge + * @property CI_DB_query_builder $db + */ +class Migration_create_table_api_access extends CI_Migration { + + + public function up() + { + $table = config_item('rest_access_table'); + $fields = array( + 'id' => [ + 'type' => 'INT(11)', + 'auto_increment' => TRUE, + 'unsigned' => TRUE, + ], + 'key' => [ + 'type' => 'VARCHAR(' . config_item('rest_key_length') . ')', + ], + 'all_access' => [ + 'type' => 'TINYINT(1)', + 'default' => 0, + ], + 'controller' => [ + 'type' => 'VARCHAR(50)', + ], + 'date_created' => [ + 'type' => 'DATETIME', + 'null' => TRUE, + ], + 'date_modified' => [ + 'type' => 'TIMESTAMP', + ], + ); + $this->dbforge->add_field($fields); + $this->dbforge->add_key('id', TRUE); + $this->dbforge->add_key('controller'); + $this->dbforge->create_table($table); + $this->db->query(add_foreign_key($table, 'key', + config_item('rest_keys_table') . '(' . config_item('rest_key_column') . ')', 'CASCADE', 'CASCADE')); + } + + + public function down() + { + $table = config_item('rest_access_table'); + if ($this->db->table_exists($table)) + { + $this->db->query(drop_foreign_key($table, 'key')); + $this->dbforge->drop_table($table); + } + } + +} diff --git a/application/migrations/20170706032825_create_table_api_limits.php b/application/migrations/20170706032825_create_table_api_limits.php new file mode 100644 index 00000000..fdbff1ff --- /dev/null +++ b/application/migrations/20170706032825_create_table_api_limits.php @@ -0,0 +1,57 @@ + + */ +defined('BASEPATH') OR exit('No direct script access allowed'); + +/** + * Class Migration_create_table_api_limits + * + * @property CI_DB_forge $dbforge + * @property CI_DB_query_builder $db + */ +class Migration_create_table_api_limits extends CI_Migration { + + + public function up() + { + $table = config_item('rest_limits_table'); + $fields = array( + 'id' => [ + 'type' => 'INT(11)', + 'auto_increment' => TRUE, + 'unsigned' => TRUE, + ], + 'api_key' => [ + 'type' => 'VARCHAR(' . config_item('rest_key_length') . ')', + ], + 'uri' => [ + 'type' => 'VARCHAR(255)', + ], + 'count' => [ + 'type' => 'INT(10)', + ], + 'hour_started' => [ + 'type' => 'INT(11)', + ], + ); + $this->dbforge->add_field($fields); + $this->dbforge->add_key('id', TRUE); + $this->dbforge->add_key('uri'); + $this->dbforge->create_table($table); + $this->db->query(add_foreign_key($table, 'api_key', + config_item('rest_keys_table') . '(' . config_item('rest_key_column') . ')', 'CASCADE', 'CASCADE')); + } + + + public function down() + { + $table = config_item('rest_limits_table'); + if ($this->db->table_exists($table)) + { + $this->db->query(drop_foreign_key($table, 'api_key')); + $this->dbforge->drop_table($table); + } + } + +} diff --git a/application/migrations/index.html b/application/migrations/index.html new file mode 100644 index 00000000..b702fbc3 --- /dev/null +++ b/application/migrations/index.html @@ -0,0 +1,11 @@ + + + + 403 Forbidden + + + +

Directory access is forbidden.

+ + + From 944c1f3c9065cab08bb385b0d4b91daa4e789079 Mon Sep 17 00:00:00 2001 From: Adrian Bean Date: Wed, 9 Aug 2017 17:01:41 +0100 Subject: [PATCH 037/129] Force validation (#809) * Update rest.php * Update REST_Controller.php Update to force the use of both the api key and the basic authentication when the config value is set in rest.php This resolves the issue of the basic auth always being valid on every request. --- application/config/rest.php | 1 + application/libraries/REST_Controller.php | 42 +++++++++++++++++------ 2 files changed, 33 insertions(+), 10 deletions(-) diff --git a/application/config/rest.php b/application/config/rest.php index deafeeb7..cdb92bf4 100644 --- a/application/config/rest.php +++ b/application/config/rest.php @@ -138,6 +138,7 @@ | */ $config['allow_auth_and_keys'] = TRUE; +$config['strict_api_and_auth'] = TRUE; // force the use of both api and auth before a valid api request is made /* |-------------------------------------------------------------------------- diff --git a/application/libraries/REST_Controller.php b/application/libraries/REST_Controller.php index d5c2b4f0..449bb747 100644 --- a/application/libraries/REST_Controller.php +++ b/application/libraries/REST_Controller.php @@ -335,6 +335,8 @@ abstract class REST_Controller extends CI_Controller { * @var bool */ protected $_enable_xss = FALSE; + + private $is_valid_request = TRUE; /** * HTTP status codes and their respective description @@ -631,17 +633,19 @@ public function _remap($object_called, $arguments = []) $this->config->item('rest_status_field_name') => FALSE, $this->config->item('rest_message_field_name') => $this->lang->line('text_rest_unsupported') ], self::HTTP_FORBIDDEN); + + $this->is_valid_request = false; } // Remove the supported format from the function name e.g. index.json => index $object_called = preg_replace('/^(.*)\.(?:'.implode('|', array_keys($this->_supported_formats)).')$/', '$1', $object_called); $controller_method = $object_called.'_'.$this->request->method; - // Does this method exist? If not, try executing an index method - if (!method_exists($this, $controller_method)) { - $controller_method = "index_" . $this->request->method; - array_unshift($arguments, $object_called); - } + // Does this method exist? If not, try executing an index method + if (!method_exists($this, $controller_method)) { + $controller_method = "index_" . $this->request->method; + array_unshift($arguments, $object_called); + } // Do we want to log this method (if allowed by config)? $log_method = ! (isset($this->methods[$controller_method]['log']) && $this->methods[$controller_method]['log'] === FALSE); @@ -656,8 +660,8 @@ public function _remap($object_called, $arguments = []) { $this->_log_request(); } - - // fix cross site to option request error + + // fix cross site to option request error if($this->request->method == 'options') { exit; } @@ -666,6 +670,8 @@ public function _remap($object_called, $arguments = []) $this->config->item('rest_status_field_name') => FALSE, $this->config->item('rest_message_field_name') => sprintf($this->lang->line('text_rest_invalid_api_key'), $this->rest->key) ], self::HTTP_FORBIDDEN); + + $this->is_valid_request = false; } // Check to see if this key has access to the requested controller @@ -680,6 +686,8 @@ public function _remap($object_called, $arguments = []) $this->config->item('rest_status_field_name') => FALSE, $this->config->item('rest_message_field_name') => $this->lang->line('text_rest_api_key_unauthorized') ], self::HTTP_UNAUTHORIZED); + + $this->is_valid_request = false; } // Sure it exists, but can they do anything with it? @@ -689,6 +697,8 @@ public function _remap($object_called, $arguments = []) $this->config->item('rest_status_field_name') => FALSE, $this->config->item('rest_message_field_name') => $this->lang->line('text_rest_unknown_method') ], self::HTTP_METHOD_NOT_ALLOWED); + + $this->is_valid_request = false; } // Doing key related stuff? Can only do it if they have a key right? @@ -699,6 +709,8 @@ public function _remap($object_called, $arguments = []) { $response = [$this->config->item('rest_status_field_name') => FALSE, $this->config->item('rest_message_field_name') => $this->lang->line('text_rest_api_key_time_limit')]; $this->response($response, self::HTTP_UNAUTHORIZED); + + $this->is_valid_request = false; } // If no level is set use 0, they probably aren't using permissions @@ -716,6 +728,8 @@ public function _remap($object_called, $arguments = []) // They don't have good enough perms $response = [$this->config->item('rest_status_field_name') => FALSE, $this->config->item('rest_message_field_name') => $this->lang->line('text_rest_api_key_permissions')]; $this->response($response, self::HTTP_UNAUTHORIZED); + + $this->is_valid_request = false; } } @@ -724,6 +738,8 @@ public function _remap($object_called, $arguments = []) { $response = [$this->config->item('rest_status_field_name') => FALSE, $this->config->item('rest_message_field_name') => $this->lang->line('text_rest_ip_address_time_limit')]; $this->response($response, self::HTTP_UNAUTHORIZED); + + $this->is_valid_request = false; } // No key stuff, but record that stuff is happening @@ -735,7 +751,9 @@ public function _remap($object_called, $arguments = []) // Call the controller method and passed arguments try { - call_user_func_array([$this, $controller_method], $arguments); + if ($this->is_valid_request) { + call_user_func_array([$this, $controller_method], $arguments); + } } catch (Exception $ex) { @@ -744,8 +762,8 @@ public function _remap($object_called, $arguments = []) } // If the method doesn't exist, then the error will be caught and an error response shown - $_error = &load_class('Exceptions', 'core'); - $_error->show_exception($ex); + $_error = &load_class('Exceptions', 'core'); + $_error->show_exception($ex); } } @@ -2136,6 +2154,10 @@ protected function _force_login($nonce = '') .'", opaque="' . md5($rest_realm).'"'); } + if ($this->config->item('strict_api_and_auth') === true) { + $this->is_valid_request = false; + } + // Display an error response $this->response([ $this->config->item('rest_status_field_name') => FALSE, From cf49abe06096d46c971266ef5c7f3626c39400b6 Mon Sep 17 00:00:00 2001 From: Hanisch-IT Date: Fri, 15 Sep 2017 17:38:02 +0200 Subject: [PATCH 038/129] Codeigniter Composer Ready (#832) * First steps for composer ready. Try to load Config/Language from this library if not existing in CI project * Add backward compatibility for Format * Add backward compatibility for Format * Add backward compatibility for Format * Update Readme Remove namespace for backward capability * Update Readme * Update readme - add language / config section --- README.md | 24 ++- application/libraries/Format.php | 2 +- application/libraries/REST_Controller.php | 211 +++++++++++++--------- composer.json | 14 +- 4 files changed, 159 insertions(+), 92 deletions(-) diff --git a/README.md b/README.md index 8943a5ce..5a9423d2 100644 --- a/README.md +++ b/README.md @@ -18,9 +18,19 @@ Please note that version 4.0.0 is in the works, and is considered a breaking cha Take a look at the "development" branch to see what's up. -## Installation +## Installation & loading -Drag and drop the **application/libraries/Format.php** and **application/libraries/REST_Controller.php** files into your application's directories. To use `require_once` it at the top of your controllers to load it into the scope. Additionally, copy the **rest.php** file from **application/config** in your application's configuration directory. +CodeIgniter Rest Server is available on [Packagist](https://packagist.org/packages/hanischit/kraken-api) (using semantic versioning), and installation via composer is the recommended way to install Kraken-api. Just add this line to your `composer.json` file: + +```json +"chriskacerguis/codeigniter-restserver": "^3.0" +``` + +or run + +```sh +composer require chriskacerguis/codeigniter-restserver +``` ## Handling Requests @@ -118,6 +128,16 @@ If you don't specify a response code, and the data you respond with `== FALSE` ( $this->response([]); // HTTP 404 Not Found ``` +## Configuration + +You can overwrite all default configurations by creating a rest.php file in your config folder with your configs. +All given configurations will overwrite the default ones. + +## Language + +You can overwrite all default language files. Just add a rest_controller_lang.php to your language and overwrite the what you want. + + ## Multilingual Support If your application uses language files to support multiple locales, `REST_Controller` will automatically parse the HTTP `Accept-Language` header and provide the language(s) in your actions. This information can be found in the `$this->response->lang` object: diff --git a/application/libraries/Format.php b/application/libraries/Format.php index b1405302..4b5ad3e6 100644 --- a/application/libraries/Format.php +++ b/application/libraries/Format.php @@ -378,7 +378,7 @@ public function to_csv($data = NULL, $delimiter = ',', $enclosure = '"') // Close the handle fclose($handle); - + // Convert UTF-8 encoding to UTF-16LE which is supported by MS Excel $csv = mb_convert_encoding($csv, 'UTF-16LE', 'UTF-8'); diff --git a/application/libraries/REST_Controller.php b/application/libraries/REST_Controller.php index 449bb747..7a1566aa 100644 --- a/application/libraries/REST_Controller.php +++ b/application/libraries/REST_Controller.php @@ -302,15 +302,15 @@ abstract class REST_Controller extends CI_Controller { * @var array */ protected $_supported_formats = [ - 'json' => 'application/json', - 'array' => 'application/json', - 'csv' => 'application/csv', - 'html' => 'text/html', - 'jsonp' => 'application/javascript', - 'php' => 'text/plain', - 'serialized' => 'application/vnd.php.serialized', - 'xml' => 'application/xml' - ]; + 'json' => 'application/json', + 'array' => 'application/json', + 'csv' => 'application/csv', + 'html' => 'text/html', + 'jsonp' => 'application/javascript', + 'php' => 'text/plain', + 'serialized' => 'application/vnd.php.serialized', + 'xml' => 'application/xml' + ]; /** * Information about the current API user @@ -335,7 +335,7 @@ abstract class REST_Controller extends CI_Controller { * @var bool */ protected $_enable_xss = FALSE; - + private $is_valid_request = TRUE; /** @@ -361,6 +361,15 @@ abstract class REST_Controller extends CI_Controller { self::HTTP_NOT_IMPLEMENTED => 'NOT IMPLEMENTED' ]; + /** + * @var Format + */ + private $format; + /** + * @var bool + */ + private $auth_override; + /** * Extend this function to apply additional checking early on in the process * @@ -395,10 +404,18 @@ public function __construct($config = 'rest') $this->_start_rtime = microtime(TRUE); // Load the rest.php configuration file - $this->load->config($config); + $this->get_local_config($config); // At present the library is bundled with REST_Controller 2.5+, but will eventually be part of CodeIgniter (no citation) - $this->load->library('format'); + if(class_exists('Format')) + { + $this->format = new Format(); + } + else + { + $this->load->library('format'); + } + // Determine supported output formats from configuration $supported_formats = $this->config->item('rest_supported_formats'); @@ -432,7 +449,7 @@ public function __construct($config = 'rest') } // Load the language file - $this->lang->load('rest_controller', $language); + $this->lang->load('rest_controller', $language, FALSE, TRUE, __DIR__.'/../'); // Initialise the response, request and rest objects $this->request = new stdClass(); @@ -477,7 +494,7 @@ public function __construct($config = 'rest') $this->request->body = NULL; $this->{'_parse_' . $this->request->method}(); - + // Fix parse method return arguments null if($this->{'_'.$this->request->method.'_args'} === null) { @@ -544,15 +561,15 @@ public function __construct($config = 'rest') { // Display an error response $this->response([ - $this->config->item('rest_status_field_name') => FALSE, - $this->config->item('rest_message_field_name') => $this->lang->line('text_rest_ajax_only') - ], self::HTTP_NOT_ACCEPTABLE); + $this->config->item('rest_status_field_name') => FALSE, + $this->config->item('rest_message_field_name') => $this->lang->line('text_rest_ajax_only') + ], self::HTTP_NOT_ACCEPTABLE); } // When there is no specific override for the current class/method, use the default auth value set in the config if ($this->auth_override === FALSE && (! ($this->config->item('rest_enable_keys') && $this->_allow === TRUE) || - ($this->config->item('allow_auth_and_keys') === TRUE && $this->_allow === TRUE))) + ($this->config->item('allow_auth_and_keys') === TRUE && $this->_allow === TRUE))) { $rest_auth = strtolower($this->config->item('rest_auth')); switch ($rest_auth) @@ -574,6 +591,25 @@ public function __construct($config = 'rest') } } + /** + * @param $config_file + */ + private function get_local_config($config_file) + { + if(file_exists(__DIR__."/../config/".$config_file.".php")) + { + $config = array(); + include(__DIR__ . "/../config/" . $config_file . ".php"); + + foreach($config AS $key => $value) + { + $this->config->set_item($key, $value); + } + } + + $this->load->config($config_file, FALSE, TRUE); + } + /** * De-constructor * @@ -623,6 +659,7 @@ protected function preflight_checks() * @access public * @param string $object_called * @param array $arguments The arguments passed to the controller method + * @throws Exception */ public function _remap($object_called, $arguments = []) { @@ -630,9 +667,9 @@ public function _remap($object_called, $arguments = []) if ($this->config->item('force_https') && $this->request->ssl === FALSE) { $this->response([ - $this->config->item('rest_status_field_name') => FALSE, - $this->config->item('rest_message_field_name') => $this->lang->line('text_rest_unsupported') - ], self::HTTP_FORBIDDEN); + $this->config->item('rest_status_field_name') => FALSE, + $this->config->item('rest_message_field_name') => $this->lang->line('text_rest_unsupported') + ], self::HTTP_FORBIDDEN); $this->is_valid_request = false; } @@ -641,11 +678,11 @@ public function _remap($object_called, $arguments = []) $object_called = preg_replace('/^(.*)\.(?:'.implode('|', array_keys($this->_supported_formats)).')$/', '$1', $object_called); $controller_method = $object_called.'_'.$this->request->method; - // Does this method exist? If not, try executing an index method - if (!method_exists($this, $controller_method)) { - $controller_method = "index_" . $this->request->method; - array_unshift($arguments, $object_called); - } + // Does this method exist? If not, try executing an index method + if (!method_exists($this, $controller_method)) { + $controller_method = "index_" . $this->request->method; + array_unshift($arguments, $object_called); + } // Do we want to log this method (if allowed by config)? $log_method = ! (isset($this->methods[$controller_method]['log']) && $this->methods[$controller_method]['log'] === FALSE); @@ -667,9 +704,9 @@ public function _remap($object_called, $arguments = []) } $this->response([ - $this->config->item('rest_status_field_name') => FALSE, - $this->config->item('rest_message_field_name') => sprintf($this->lang->line('text_rest_invalid_api_key'), $this->rest->key) - ], self::HTTP_FORBIDDEN); + $this->config->item('rest_status_field_name') => FALSE, + $this->config->item('rest_message_field_name') => sprintf($this->lang->line('text_rest_invalid_api_key'), $this->rest->key) + ], self::HTTP_FORBIDDEN); $this->is_valid_request = false; } @@ -683,9 +720,9 @@ public function _remap($object_called, $arguments = []) } $this->response([ - $this->config->item('rest_status_field_name') => FALSE, - $this->config->item('rest_message_field_name') => $this->lang->line('text_rest_api_key_unauthorized') - ], self::HTTP_UNAUTHORIZED); + $this->config->item('rest_status_field_name') => FALSE, + $this->config->item('rest_message_field_name') => $this->lang->line('text_rest_api_key_unauthorized') + ], self::HTTP_UNAUTHORIZED); $this->is_valid_request = false; } @@ -694,9 +731,9 @@ public function _remap($object_called, $arguments = []) if (! method_exists($this, $controller_method)) { $this->response([ - $this->config->item('rest_status_field_name') => FALSE, - $this->config->item('rest_message_field_name') => $this->lang->line('text_rest_unknown_method') - ], self::HTTP_METHOD_NOT_ALLOWED); + $this->config->item('rest_status_field_name') => FALSE, + $this->config->item('rest_message_field_name') => $this->lang->line('text_rest_unknown_method') + ], self::HTTP_METHOD_NOT_ALLOWED); $this->is_valid_request = false; } @@ -762,8 +799,8 @@ public function _remap($object_called, $arguments = []) } // If the method doesn't exist, then the error will be caught and an error response shown - $_error = &load_class('Exceptions', 'core'); - $_error->show_exception($ex); + $_error = &load_class('Exceptions', 'core'); + $_error->show_exception($ex); } } @@ -778,7 +815,7 @@ public function _remap($object_called, $arguments = []) */ public function response($data = NULL, $http_code = NULL, $continue = FALSE) { - ob_start(); + ob_start(); // If the HTTP status is not NULL, then cast as an integer if ($http_code !== NULL) { @@ -847,10 +884,10 @@ public function response($data = NULL, $http_code = NULL, $continue = FALSE) $this->output->_display(); exit; } - else - { - ob_end_flush(); - } + else + { + ob_end_flush(); + } // Otherwise dump the output automatically } @@ -1099,7 +1136,7 @@ protected function _detect_api_key() * Preferred return language * * @access protected - * @return string|NULL The language code + * @return string|NULL|array The language code */ protected function _detect_lang() { @@ -1177,28 +1214,28 @@ protected function _check_limit($controller_method) switch ($this->config->item('rest_limits_method')) { - case 'IP_ADDRESS': - $limited_uri = 'ip-address:' .$this->input->ip_address(); - $api_key = $this->input->ip_address(); - break; + case 'IP_ADDRESS': + $limited_uri = 'ip-address:' .$this->input->ip_address(); + $api_key = $this->input->ip_address(); + break; - case 'API_KEY': - $limited_uri = 'api-key:' . $api_key; - break; + case 'API_KEY': + $limited_uri = 'api-key:' . $api_key; + break; - case 'METHOD_NAME': - $limited_uri = 'method-name:' . $controller_method; - break; + case 'METHOD_NAME': + $limited_uri = 'method-name:' . $controller_method; + break; - case 'ROUTED_URL': - default: - $limited_uri = $this->uri->ruri_string(); - if (strpos(strrev($limited_uri), strrev($this->response->format)) === 0) - { - $limited_uri = substr($limited_uri,0, -strlen($this->response->format) - 1); - } - $limited_uri = 'uri:'.$limited_uri.':'.$this->request->method; // It's good to differentiate GET from PUT - break; + case 'ROUTED_URL': + default: + $limited_uri = $this->uri->ruri_string(); + if (strpos(strrev($limited_uri), strrev($this->response->format)) === 0) + { + $limited_uri = substr($limited_uri,0, -strlen($this->response->format) - 1); + } + $limited_uri = 'uri:'.$limited_uri.':'.$this->request->method; // It's good to differentiate GET from PUT + break; } if (isset($this->methods[$controller_method]['limit']) === FALSE ) @@ -1501,8 +1538,8 @@ protected function _parse_put() } else if ($this->input->method() === 'put') { - // If no file type is provided, then there are probably just arguments - $this->_put_args = $this->input->input_stream(); + // If no file type is provided, then there are probably just arguments + $this->_put_args = $this->input->input_stream(); } } @@ -1974,9 +2011,9 @@ protected function _check_php_session() { // Display an error response $this->response([ - $this->config->item('rest_status_field_name') => FALSE, - $this->config->item('rest_message_field_name') => $this->lang->line('text_rest_unauthorized') - ], self::HTTP_UNAUTHORIZED); + $this->config->item('rest_status_field_name') => FALSE, + $this->config->item('rest_message_field_name') => $this->lang->line('text_rest_unauthorized') + ], self::HTTP_UNAUTHORIZED); } } @@ -2072,9 +2109,9 @@ protected function _prepare_digest_auth() { // Display an error response $this->response([ - $this->config->item('rest_status_field_name') => FALSE, - $this->config->item('rest_message_field_name') => $this->lang->line('text_rest_invalid_credentials') - ], self::HTTP_UNAUTHORIZED); + $this->config->item('rest_status_field_name') => FALSE, + $this->config->item('rest_message_field_name') => $this->lang->line('text_rest_invalid_credentials') + ], self::HTTP_UNAUTHORIZED); } } @@ -2094,9 +2131,9 @@ protected function _check_blacklist_auth() { // Display an error response $this->response([ - $this->config->item('rest_status_field_name') => FALSE, - $this->config->item('rest_message_field_name') => $this->lang->line('text_rest_ip_denied') - ], self::HTTP_UNAUTHORIZED); + $this->config->item('rest_status_field_name') => FALSE, + $this->config->item('rest_message_field_name') => $this->lang->line('text_rest_ip_denied') + ], self::HTTP_UNAUTHORIZED); } } @@ -2122,9 +2159,9 @@ protected function _check_whitelist_auth() if (in_array($this->input->ip_address(), $whitelist) === FALSE) { $this->response([ - $this->config->item('rest_status_field_name') => FALSE, - $this->config->item('rest_message_field_name') => $this->lang->line('text_rest_ip_unauthorized') - ], self::HTTP_UNAUTHORIZED); + $this->config->item('rest_status_field_name') => FALSE, + $this->config->item('rest_message_field_name') => $this->lang->line('text_rest_ip_unauthorized') + ], self::HTTP_UNAUTHORIZED); } } @@ -2160,9 +2197,9 @@ protected function _force_login($nonce = '') // Display an error response $this->response([ - $this->config->item('rest_status_field_name') => FALSE, - $this->config->item('rest_message_field_name') => $this->lang->line('text_rest_unauthorized') - ], self::HTTP_UNAUTHORIZED); + $this->config->item('rest_status_field_name') => FALSE, + $this->config->item('rest_message_field_name') => $this->lang->line('text_rest_unauthorized') + ], self::HTTP_UNAUTHORIZED); } /** @@ -2177,9 +2214,9 @@ protected function _log_access_time() $payload['rtime'] = $this->_end_rtime - $this->_start_rtime; return $this->rest->db->update( - $this->config->item('rest_logs_table'), $payload, [ - 'id' => $this->_insert_id - ]); + $this->config->item('rest_logs_table'), $payload, [ + 'id' => $this->_insert_id + ]); } /** @@ -2221,7 +2258,7 @@ protected function _check_access() if (!empty($accessRow) && !empty($accessRow['all_access'])) { - return TRUE; + return TRUE; } // Fetch controller based on path and controller name @@ -2236,10 +2273,10 @@ protected function _check_access() // Query the access table and get the number of results return $this->rest->db - ->where('key', $this->rest->key) - ->where('controller', $controller) - ->get($this->config->item('rest_access_table')) - ->num_rows() > 0; + ->where('key', $this->rest->key) + ->where('controller', $controller) + ->get($this->config->item('rest_access_table')) + ->num_rows() > 0; } /** diff --git a/composer.json b/composer.json index a4d014d7..a4b9f670 100644 --- a/composer.json +++ b/composer.json @@ -1,9 +1,9 @@ { "description": "REST Server for the CodeIgniter framework", "name": "chriskacerguis/codeigniter-restserver", - "type": "project", + "type": "library", "homepage": "https://github.com/chriskacerguis/codeigniter-restserver", - "authors": [ + "authors": [ { "name": "Chris Kacerguis", "role": "Developer" @@ -12,5 +12,15 @@ "license": "MIT", "support": { "source": "https://github.com/chriskacerguis/codeigniter-restserver" + }, + "require": { + "php": ">=5.4.0", + "codeigniter/framework": "^3.0.4" + }, + "autoload": { + "classmap": [ + "application/libraries/Format.php", + "application/libraries/REST_Controller.php" + ] } } \ No newline at end of file From 27f26f093d37ab02ea420c0fbb2784cfa24dfbc4 Mon Sep 17 00:00:00 2001 From: Hanisch-IT Date: Sat, 23 Sep 2017 03:11:53 +0200 Subject: [PATCH 039/129] Bugfix (#842) - Fix: format initialization without composer - Fix: Readme --- README.md | 2 +- application/libraries/REST_Controller.php | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5a9423d2..c8cf8c0a 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ Take a look at the "development" branch to see what's up. ## Installation & loading -CodeIgniter Rest Server is available on [Packagist](https://packagist.org/packages/hanischit/kraken-api) (using semantic versioning), and installation via composer is the recommended way to install Kraken-api. Just add this line to your `composer.json` file: +CodeIgniter Rest Server is available on [Packagist](https://packagist.org/packages/chriskacerguis/codeigniter-restserver) (using semantic versioning), and installation via composer is the recommended way to install Codeigniter Rest Server. Just add this line to your `composer.json` file: ```json "chriskacerguis/codeigniter-restserver": "^3.0" diff --git a/application/libraries/REST_Controller.php b/application/libraries/REST_Controller.php index 7a1566aa..e9a3023d 100644 --- a/application/libraries/REST_Controller.php +++ b/application/libraries/REST_Controller.php @@ -413,7 +413,8 @@ public function __construct($config = 'rest') } else { - $this->load->library('format'); + $this->load->library('Format', NULL, 'libraryFormat'); + $this->format = $this->libraryFormat; } From d3e39dbfd4d29d81e018396da0e5ea72ebd7face Mon Sep 17 00:00:00 2001 From: ganlei <769323213@qq.com> Date: Fri, 22 Sep 2017 20:16:15 -0500 Subject: [PATCH 040/129] Fix: A Database Error Occurred when update logs (_log_access_time and _log_response_code) (#830) --- application/libraries/REST_Controller.php | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/application/libraries/REST_Controller.php b/application/libraries/REST_Controller.php index e9a3023d..c797ab11 100644 --- a/application/libraries/REST_Controller.php +++ b/application/libraries/REST_Controller.php @@ -2212,6 +2212,10 @@ protected function _force_login($nonce = '') */ protected function _log_access_time() { + if($this->_insert_id == ''){ + return false; + } + $payload['rtime'] = $this->_end_rtime - $this->_start_rtime; return $this->rest->db->update( @@ -2230,6 +2234,10 @@ protected function _log_access_time() */ protected function _log_response_code($http_code) { + if($this->_insert_id == ''){ + return false; + } + $payload['response_code'] = $http_code; return $this->rest->db->update( From 870a288f6570e4652d9b04909fe57b19e9f2de0e Mon Sep 17 00:00:00 2001 From: Hanisch-IT Date: Sat, 23 Sep 2017 18:44:17 +0200 Subject: [PATCH 041/129] Bugfix/#844 ldap configuration (#847) * Bugfix - Fix: format initialization without composer - Fix: Readme * Bugfix: Make LDAP available - Created missing config ldap.php - Correct loading of config (remove .php) --- application/config/ldap.php | 15 +++++++++++++++ application/libraries/REST_Controller.php | 2 +- 2 files changed, 16 insertions(+), 1 deletion(-) create mode 100644 application/config/ldap.php diff --git a/application/config/ldap.php b/application/config/ldap.php new file mode 100644 index 00000000..e4165550 --- /dev/null +++ b/application/config/ldap.php @@ -0,0 +1,15 @@ +config->load('ldap.php', TRUE); + $this->config->load('ldap', TRUE); $ldap = [ 'timeout' => $this->config->item('timeout', 'ldap'), From 3a5ba0dffdebd24cc215ef714b72208c88304203 Mon Sep 17 00:00:00 2001 From: Hanisch-IT Date: Sat, 23 Sep 2017 18:44:55 +0200 Subject: [PATCH 042/129] Bugfix/#837 add http authorization (#848) * Bugfix - Fix: format initialization without composer - Fix: Readme * Make HTTP_AUTHORIZATION possible - To hold backward compatibility HTTP_AUTHORIZATION and HTTP_AUTHANTICATION are possible --- application/libraries/REST_Controller.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/application/libraries/REST_Controller.php b/application/libraries/REST_Controller.php index bbb3dbc4..87a126ed 100644 --- a/application/libraries/REST_Controller.php +++ b/application/libraries/REST_Controller.php @@ -2034,7 +2034,7 @@ protected function _prepare_basic_auth() // Returns NULL if the SERVER variables PHP_AUTH_USER and HTTP_AUTHENTICATION don't exist $username = $this->input->server('PHP_AUTH_USER'); - $http_auth = $this->input->server('HTTP_AUTHENTICATION'); + $http_auth = $this->input->server('HTTP_AUTHENTICATION') ?: $this->input->server('HTTP_AUTHORIZATION'); $password = NULL; if ($username !== NULL) From 3cee80acab45804efca300a4f2030eb69b9a945b Mon Sep 17 00:00:00 2001 From: Hanisch-IT Date: Mon, 25 Sep 2017 01:13:48 +0200 Subject: [PATCH 043/129] Issue #849 Adding AUTHORS.md (#850) --- AUTHORS.md | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 AUTHORS.md diff --git a/AUTHORS.md b/AUTHORS.md new file mode 100644 index 00000000..0a41747e --- /dev/null +++ b/AUTHORS.md @@ -0,0 +1,9 @@ +# The Core Team + +* [Chris Kacerguis](//github.com/chriskacerguis) + +### Special Thanks To + +* [Fabian Hanisch](//github.com/Hanisch-IT) + +*For a list of people who have contributed to the codebase, see [GitHub's list of contributors](https://github.com/chriskacerguis/codeigniter-restserver/graphs/contributors).* \ No newline at end of file From 3ec22ef11722b41653f21e4444af13ec13639b9f Mon Sep 17 00:00:00 2001 From: Chris Kacerguis Date: Sun, 24 Sep 2017 18:15:15 -0500 Subject: [PATCH 044/129] added comment and Phil's name --- AUTHORS.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/AUTHORS.md b/AUTHORS.md index 0a41747e..4d281fc1 100644 --- a/AUTHORS.md +++ b/AUTHORS.md @@ -1,9 +1,10 @@ # The Core Team * [Chris Kacerguis](//github.com/chriskacerguis) +* [Phil Sturgeon] (https://github.com/philsturgeon) ### Special Thanks To * [Fabian Hanisch](//github.com/Hanisch-IT) -*For a list of people who have contributed to the codebase, see [GitHub's list of contributors](https://github.com/chriskacerguis/codeigniter-restserver/graphs/contributors).* \ No newline at end of file +*For a list of people who have contributed to the codebase, see [GitHub's list of contributors](https://github.com/chriskacerguis/codeigniter-restserver/graphs/contributors). Anyone who has contributed please do a PR and add to this file.* From 3ba8186d941e3ae36c1e9fd484bd74bc36aa3855 Mon Sep 17 00:00:00 2001 From: Chris Kacerguis Date: Sun, 24 Sep 2017 18:15:34 -0500 Subject: [PATCH 045/129] fix typo --- AUTHORS.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/AUTHORS.md b/AUTHORS.md index 4d281fc1..ee3551f6 100644 --- a/AUTHORS.md +++ b/AUTHORS.md @@ -1,7 +1,7 @@ # The Core Team * [Chris Kacerguis](//github.com/chriskacerguis) -* [Phil Sturgeon] (https://github.com/philsturgeon) +* [Phil Sturgeon](//github.com/philsturgeon) ### Special Thanks To From 544f30b62a65ff81bc397c5077cd37b24102fff1 Mon Sep 17 00:00:00 2001 From: Zeeshan Date: Wed, 4 Oct 2017 17:02:58 +0530 Subject: [PATCH 046/129] Profiling feature added to master (#855) * Config,hook & default profiler parameters Config,hook & default profiler parameters * Added hook for profiler Added hook for profiler * check added for profiling enabled/disabled check added for profiling enabled/disabled * Rename file config.php to config.php.sample Rename file config.php to config.php.sample * Added profiling settings to readme Added profiling settings to readme --- README.md | 13 + application/config/config.php.sample | 482 ++++++++++++++++++++++ application/config/hooks.php | 21 + application/config/profiler.php | 26 ++ application/hooks/hooks.profiler.php | 18 + application/libraries/REST_Controller.php | 157 +++---- 6 files changed, 642 insertions(+), 75 deletions(-) create mode 100644 application/config/config.php.sample create mode 100644 application/config/hooks.php create mode 100644 application/config/profiler.php create mode 100644 application/hooks/hooks.profiler.php diff --git a/README.md b/README.md index c8cf8c0a..5eb82281 100644 --- a/README.md +++ b/README.md @@ -210,6 +210,19 @@ By default, the HTTP will be `X-API-KEY`. This can be configured in **config/res ```bash $ curl -X POST -H "X-API-KEY: some_key_here" http://example.com/books ``` +## Profiling +Codeigniter Profiler feature has been added to the library, so that you can use the power of CI profiler in your project just by setting config parameter to enable profile through out your application +Turn it on in your **config/config.php** file: + +```php +TRUE to turn profile ON, FALSE to turn it off +$config['enable_profiling'] = FALSE; +``` +Also you need to enable `hooks` in your config.php that looks like this +```php +$config['enable_hooks'] = TRUE; +``` +Also you can refer to **config/config.php.sample** ## Other Documentation / Tutorials diff --git a/application/config/config.php.sample b/application/config/config.php.sample new file mode 100644 index 00000000..77411ce1 --- /dev/null +++ b/application/config/config.php.sample @@ -0,0 +1,482 @@ +]+$/i +| +| DO NOT CHANGE THIS UNLESS YOU FULLY UNDERSTAND THE REPERCUSSIONS!! +| +| Note: This option is ignored for CLI requests. +| +*/ +$config['permitted_uri_chars'] = 'a-z 0-9~%.:_\-'; + +/* +|-------------------------------------------------------------------------- +| Enable Query Strings +|-------------------------------------------------------------------------- +| +| By default CodeIgniter uses search-engine friendly segment based URLs: +| example.com/who/what/where/ +| +| You can optionally enable standard query string based URLs: +| example.com?who=me&what=something&where=here +| +| Options are: TRUE or FALSE (boolean) +| +| The other items let you set the query string 'words' that will +| invoke your controllers and its functions: +| example.com/index.php?c=controller&m=function +| +| Please note that some of the helpers won't work as expected when +| this feature is enabled, since CodeIgniter is designed primarily to +| use segment based URLs. +| +*/ +$config['enable_query_strings'] = FALSE; +$config['controller_trigger'] = 'c'; +$config['function_trigger'] = 'm'; +$config['directory_trigger'] = 'd'; + +/* +|-------------------------------------------------------------------------- +| Error Logging Threshold +|-------------------------------------------------------------------------- +| +| You can enable error logging by setting a threshold over zero. The +| threshold determines what gets logged. Threshold options are: +| +| 0 = Disables logging, Error logging TURNED OFF +| 1 = Error Messages (including PHP errors) +| 2 = Debug Messages +| 3 = Informational Messages +| 4 = All Messages +| +| You can also pass an array with threshold levels to show individual error types +| +| array(2) = Debug Messages, without Error Messages +| +| For a live site you'll usually only enable Errors (1) to be logged otherwise +| your log files will fill up very fast. +| +*/ +$config['log_threshold'] = 0; + +/* +|-------------------------------------------------------------------------- +| Error Logging Directory Path +|-------------------------------------------------------------------------- +| +| Leave this BLANK unless you would like to set something other than the default +| application/logs/ directory. Use a full server path. +| +*/ +$config['log_path'] = ''; + +/* +|-------------------------------------------------------------------------- +| Log File Extension +|-------------------------------------------------------------------------- +| +| The default filename extension for log files. The default 'php' allows for +| protecting the log files via basic scripting, when they are to be stored +| under a publicly accessible directory. +| +| Note: Leaving it blank will default to 'php'. +| +*/ +$config['log_file_extension'] = ''; + +/* +|-------------------------------------------------------------------------- +| Log File Permissions +|-------------------------------------------------------------------------- +| +| The file system permissions to be applied on newly created log files. +| +| IMPORTANT: This MUST be an integer (no quotes) and you MUST use octal +| integer notation (i.e. 0700, 0644, etc.) +*/ +$config['log_file_permissions'] = 0644; + +/* +|-------------------------------------------------------------------------- +| Date Format for Logs +|-------------------------------------------------------------------------- +| +| Each item that is logged has an associated date. You can use PHP date +| codes to set your own date formatting +| +*/ +$config['log_date_format'] = 'Y-m-d H:i:s'; + +/* +|-------------------------------------------------------------------------- +| Error Views Directory Path +|-------------------------------------------------------------------------- +| +| Leave this BLANK unless you would like to set something other than the default +| application/views/errors/ directory. Use a full server path. +| +*/ +$config['error_views_path'] = ''; + +/* +|-------------------------------------------------------------------------- +| Cache Directory Path +|-------------------------------------------------------------------------- +| +| Leave this BLANK unless you would like to set something other than the default +| application/cache/ directory. Use a full server path. +| +*/ +$config['cache_path'] = ''; + +/* +|-------------------------------------------------------------------------- +| Cache Include Query String +|-------------------------------------------------------------------------- +| +| Whether to take the URL query string into consideration when generating +| output cache files. Valid options are: +| +| FALSE = Disabled +| TRUE = Enabled, take all query parameters into account. +| Please be aware that this may result in numerous cache +| files generated for the same page over and over again. +| array('q') = Enabled, but only take into account the specified list +| of query parameters. +| +*/ +$config['cache_query_string'] = FALSE; + +/* +|-------------------------------------------------------------------------- +| Encryption Key +|-------------------------------------------------------------------------- +| +| If you use the Encryption class, you must set an encryption key. +| See the user guide for more info. +| +| https://codeigniter.com/user_guide/libraries/encryption.html +| +*/ +$config['encryption_key'] = ''; + +/* +|-------------------------------------------------------------------------- +| Session Variables +|-------------------------------------------------------------------------- +| +| 'sess_driver' +| +| The storage driver to use: files, database, redis, memcached +| +| 'sess_cookie_name' +| +| The session cookie name, must contain only [0-9a-z_-] characters +| +| 'sess_expiration' +| +| The number of SECONDS you want the session to last. +| Setting to 0 (zero) means expire when the browser is closed. +| +| 'sess_save_path' +| +| The location to save sessions to, driver dependent. +| +| For the 'files' driver, it's a path to a writable directory. +| WARNING: Only absolute paths are supported! +| +| For the 'database' driver, it's a table name. +| Please read up the manual for the format with other session drivers. +| +| IMPORTANT: You are REQUIRED to set a valid save path! +| +| 'sess_match_ip' +| +| Whether to match the user's IP address when reading the session data. +| +| WARNING: If you're using the database driver, don't forget to update +| your session table's PRIMARY KEY when changing this setting. +| +| 'sess_time_to_update' +| +| How many seconds between CI regenerating the session ID. +| +| 'sess_regenerate_destroy' +| +| Whether to destroy session data associated with the old session ID +| when auto-regenerating the session ID. When set to FALSE, the data +| will be later deleted by the garbage collector. +| +| Other session cookie settings are shared with the rest of the application, +| except for 'cookie_prefix' and 'cookie_httponly', which are ignored here. +| +*/ +$config['sess_driver'] = 'files'; +$config['sess_cookie_name'] = 'ci_session'; +$config['sess_expiration'] = 7200; +$config['sess_save_path'] = NULL; +$config['sess_match_ip'] = FALSE; +$config['sess_time_to_update'] = 300; +$config['sess_regenerate_destroy'] = FALSE; + +/* +|-------------------------------------------------------------------------- +| Cookie Related Variables +|-------------------------------------------------------------------------- +| +| 'cookie_prefix' = Set a cookie name prefix if you need to avoid collisions +| 'cookie_domain' = Set to .your-domain.com for site-wide cookies +| 'cookie_path' = Typically will be a forward slash +| 'cookie_secure' = Cookie will only be set if a secure HTTPS connection exists. +| 'cookie_httponly' = Cookie will only be accessible via HTTP(S) (no javascript) +| +| Note: These settings (with the exception of 'cookie_prefix' and +| 'cookie_httponly') will also affect sessions. +| +*/ +$config['cookie_prefix'] = ''; +$config['cookie_domain'] = ''; +$config['cookie_path'] = '/'; +$config['cookie_secure'] = FALSE; +$config['cookie_httponly'] = FALSE; + +/* +|-------------------------------------------------------------------------- +| Cross Site Request Forgery +|-------------------------------------------------------------------------- +| Enables a CSRF cookie token to be set. When set to TRUE, token will be +| checked on a submitted form. If you are accepting user data, it is strongly +| recommended CSRF protection be enabled. +| +| 'csrf_token_name' = The token name +| 'csrf_cookie_name' = The cookie name +| 'csrf_expire' = The number in seconds the token should expire. +| 'csrf_regenerate' = Regenerate token on every submission +| 'csrf_exclude_uris' = Array of URIs which ignore CSRF checks +*/ +$config['csrf_protection'] = FALSE; +$config['csrf_token_name'] = 'csrf_test_name'; +$config['csrf_cookie_name'] = 'csrf_cookie_name'; +$config['csrf_expire'] = 7200; +$config['csrf_regenerate'] = TRUE; +$config['csrf_exclude_uris'] = array(); + +/* +|-------------------------------------------------------------------------- +| Output Compression +|-------------------------------------------------------------------------- +| +| Enables Gzip output compression for faster page loads. When enabled, +| the output class will test whether your server supports Gzip. +| Even if it does, however, not all browsers support compression +| so enable only if you are reasonably sure your visitors can handle it. +| +| Only used if zlib.output_compression is turned off in your php.ini. +| Please do not use it together with httpd-level output compression. +| +| VERY IMPORTANT: If you are getting a blank page when compression is enabled it +| means you are prematurely outputting something to your browser. It could +| even be a line of whitespace at the end of one of your scripts. For +| compression to work, nothing can be sent before the output buffer is called +| by the output class. Do not 'echo' any values with compression enabled. +| +*/ +$config['compress_output'] = FALSE; + +/* +|-------------------------------------------------------------------------- +| Master Time Reference +|-------------------------------------------------------------------------- +| +| Options are 'local' or any PHP supported timezone. This preference tells +| the system whether to use your server's local time as the master 'now' +| reference, or convert it to the configured one timezone. See the 'date +| helper' page of the user guide for information regarding date handling. +| +*/ +$config['time_reference'] = 'local'; + +/* +|-------------------------------------------------------------------------- +| Reverse Proxy IPs +|-------------------------------------------------------------------------- +| +| If your server is behind a reverse proxy, you must whitelist the proxy +| IP addresses from which CodeIgniter should trust headers such as +| HTTP_X_FORWARDED_FOR and HTTP_CLIENT_IP in order to properly identify +| the visitor's IP address. +| +| You can use both an array or a comma-separated list of proxy addresses, +| as well as specifying whole subnets. Here are a few examples: +| +| Comma-separated: '10.0.1.200,192.168.5.0/24' +| Array: array('10.0.1.200', '192.168.5.0/24') +*/ +$config['proxy_ips'] = ''; diff --git a/application/config/hooks.php b/application/config/hooks.php new file mode 100644 index 00000000..7268904b --- /dev/null +++ b/application/config/hooks.php @@ -0,0 +1,21 @@ + 'ProfilerEnabler', + 'function' => 'enableProfiler', + 'filename' => 'hooks.profiler.php', + 'filepath' => 'hooks', + 'params' => array() +); \ No newline at end of file diff --git a/application/config/profiler.php b/application/config/profiler.php new file mode 100644 index 00000000..ce026a7e --- /dev/null +++ b/application/config/profiler.php @@ -0,0 +1,26 @@ +output->enable_profiler( config_item('enable_profiling') ); + } +} +?> diff --git a/application/libraries/REST_Controller.php b/application/libraries/REST_Controller.php index 87a126ed..b6055c6b 100644 --- a/application/libraries/REST_Controller.php +++ b/application/libraries/REST_Controller.php @@ -816,81 +816,88 @@ public function _remap($object_called, $arguments = []) */ public function response($data = NULL, $http_code = NULL, $continue = FALSE) { - ob_start(); - // If the HTTP status is not NULL, then cast as an integer - if ($http_code !== NULL) - { - // So as to be safe later on in the process - $http_code = (int) $http_code; - } - - // Set the output as NULL by default - $output = NULL; - - // If data is NULL and no HTTP status code provided, then display, error and exit - if ($data === NULL && $http_code === NULL) - { - $http_code = self::HTTP_NOT_FOUND; - } - - // If data is not NULL and a HTTP status code provided, then continue - elseif ($data !== NULL) - { - // If the format method exists, call and return the output in that format - if (method_exists($this->format, 'to_' . $this->response->format)) - { - // Set the format header - $this->output->set_content_type($this->_supported_formats[$this->response->format], strtolower($this->config->item('charset'))); - $output = $this->format->factory($data)->{'to_' . $this->response->format}(); - - // An array must be parsed as a string, so as not to cause an array to string error - // Json is the most appropriate form for such a data type - if ($this->response->format === 'array') - { - $output = $this->format->factory($output)->{'to_json'}(); - } - } - else - { - // If an array or object, then parse as a json, so as to be a 'string' - if (is_array($data) || is_object($data)) - { - $data = $this->format->factory($data)->{'to_json'}(); - } - - // Format is not supported, so output the raw data as a string - $output = $data; - } - } - - // If not greater than zero, then set the HTTP status code as 200 by default - // Though perhaps 500 should be set instead, for the developer not passing a - // correct HTTP status code - $http_code > 0 || $http_code = self::HTTP_OK; - - $this->output->set_status_header($http_code); - - // JC: Log response code only if rest logging enabled - if ($this->config->item('rest_enable_logging') === TRUE) - { - $this->_log_response_code($http_code); - } - - // Output the data - $this->output->set_output($output); - - if ($continue === FALSE) - { - // Display the data and exit execution - $this->output->_display(); - exit; - } - else - { - ob_end_flush(); - } - - // Otherwise dump the output automatically + //if profiling enabled then print profiling data + $isProfilingEnabled = $this->config->item('enable_profiling'); + if(!$isProfilingEnabled){ + ob_start(); + // If the HTTP status is not NULL, then cast as an integer + if ($http_code !== NULL) + { + // So as to be safe later on in the process + $http_code = (int) $http_code; + } + + // Set the output as NULL by default + $output = NULL; + + // If data is NULL and no HTTP status code provided, then display, error and exit + if ($data === NULL && $http_code === NULL) + { + $http_code = self::HTTP_NOT_FOUND; + } + + // If data is not NULL and a HTTP status code provided, then continue + elseif ($data !== NULL) + { + // If the format method exists, call and return the output in that format + if (method_exists($this->format, 'to_' . $this->response->format)) + { + // Set the format header + $this->output->set_content_type($this->_supported_formats[$this->response->format], strtolower($this->config->item('charset'))); + $output = $this->format->factory($data)->{'to_' . $this->response->format}(); + + // An array must be parsed as a string, so as not to cause an array to string error + // Json is the most appropriate form for such a data type + if ($this->response->format === 'array') + { + $output = $this->format->factory($output)->{'to_json'}(); + } + } + else + { + // If an array or object, then parse as a json, so as to be a 'string' + if (is_array($data) || is_object($data)) + { + $data = $this->format->factory($data)->{'to_json'}(); + } + + // Format is not supported, so output the raw data as a string + $output = $data; + } + } + + // If not greater than zero, then set the HTTP status code as 200 by default + // Though perhaps 500 should be set instead, for the developer not passing a + // correct HTTP status code + $http_code > 0 || $http_code = self::HTTP_OK; + + $this->output->set_status_header($http_code); + + // JC: Log response code only if rest logging enabled + if ($this->config->item('rest_enable_logging') === TRUE) + { + $this->_log_response_code($http_code); + } + + // Output the data + $this->output->set_output($output); + + if ($continue === FALSE) + { + // Display the data and exit execution + $this->output->_display(); + exit; + } + else + { + ob_end_flush(); + } + + // Otherwise dump the output automatically + } + else{ + echo json_encode($data); + } } /** From cffc5904c625a22638852d53405096120b03898c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=BAlio=20Sebasti=C3=A3o?= Date: Fri, 6 Oct 2017 15:58:45 +0100 Subject: [PATCH 047/129] special chars encoding (#858) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Special chars, such as "ç" and "ã", that are abundant in my language (portuguese) were being transformed into strange things. with this change, they're showing up just right... --- application/libraries/Format.php | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/application/libraries/Format.php b/application/libraries/Format.php index 4b5ad3e6..60a83a35 100644 --- a/application/libraries/Format.php +++ b/application/libraries/Format.php @@ -406,21 +406,21 @@ public function to_json($data = NULL) if (empty($callback) === TRUE) { - return json_encode($data); + return json_encode($data, JSON_UNESCAPED_UNICODE); } // We only honour a jsonp callback which are valid javascript identifiers elseif (preg_match('/^[a-z_\$][a-z0-9\$_]*(\.[a-z_\$][a-z0-9\$_]*)*$/i', $callback)) { // Return the data as encoded json with a callback - return $callback.'('.json_encode($data).');'; + return $callback.'('.json_encode($data, JSON_UNESCAPED_UNICODE).');'; } // An invalid jsonp callback function provided. // Though I don't believe this should be hardcoded here $data['warning'] = 'INVALID JSONP CALLBACK: '.$callback; - return json_encode($data); + return json_encode($data, JSON_UNESCAPED_UNICODE); } /** From 60fcb7d08d6e30ad82218cd18e7f1b688b83b706 Mon Sep 17 00:00:00 2001 From: Chris Kacerguis Date: Fri, 17 Nov 2017 20:48:15 -0600 Subject: [PATCH 048/129] added sponsor to readme --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 5eb82281..49ffec65 100644 --- a/README.md +++ b/README.md @@ -237,3 +237,9 @@ Pull Requests are the best way to fix bugs or add features. I know loads of you contribute if you have improvements to be made and I'll keep releasing versions over time. [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://raw.githubusercontent.com/chriskacerguis/codeigniter-restserver/master/LICENSE) + +## Sponsor + + + Sponsor + From 96b921db16f3a51fe782dbf4533fa17741687886 Mon Sep 17 00:00:00 2001 From: Chris Kacerguis Date: Sat, 25 Nov 2017 10:56:44 -0600 Subject: [PATCH 049/129] remove sponsors --- README.md | 6 ------ 1 file changed, 6 deletions(-) diff --git a/README.md b/README.md index 49ffec65..5eb82281 100644 --- a/README.md +++ b/README.md @@ -237,9 +237,3 @@ Pull Requests are the best way to fix bugs or add features. I know loads of you contribute if you have improvements to be made and I'll keep releasing versions over time. [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://raw.githubusercontent.com/chriskacerguis/codeigniter-restserver/master/LICENSE) - -## Sponsor - - - Sponsor - From 9791010d18d324638a36026c226f76a291068e38 Mon Sep 17 00:00:00 2001 From: Chris Kacerguis Date: Sat, 25 Nov 2017 10:57:09 -0600 Subject: [PATCH 050/129] remove unneeded badge --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index 5eb82281..d192d4ae 100644 --- a/README.md +++ b/README.md @@ -235,5 +235,3 @@ as he is no longer using it. As of 2013/11/20 further development and support w Pull Requests are the best way to fix bugs or add features. I know loads of you use this, so please contribute if you have improvements to be made and I'll keep releasing versions over time. - -[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://raw.githubusercontent.com/chriskacerguis/codeigniter-restserver/master/LICENSE) From 5a4467bfcc217497a56a649600d10737a8fdb31e Mon Sep 17 00:00:00 2001 From: Petko Bossakov Date: Tue, 27 Feb 2018 23:34:26 +0200 Subject: [PATCH 051/129] bugfix: if the check_cors and rest_enable_logging options are both enabled, an OPTIONS request will cause a fatal error (#882) --- application/libraries/REST_Controller.php | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/application/libraries/REST_Controller.php b/application/libraries/REST_Controller.php index b6055c6b..17c35388 100644 --- a/application/libraries/REST_Controller.php +++ b/application/libraries/REST_Controller.php @@ -2336,6 +2336,11 @@ protected function _check_cors() // If the request HTTP method is 'OPTIONS', kill the response and send it to the client if ($this->input->method() === 'options') { + // Load DB if needed for logging + if (!isset($this->rest->db) && $this->config->item('rest_enable_logging')) + { + $this->rest->db = $this->load->database($this->config->item('rest_database_group'), TRUE); + } exit; } } From 0ad0310056756e88f8d328d65b2744e9cbc48762 Mon Sep 17 00:00:00 2001 From: Juan Manuel Herrera Carrera Date: Tue, 27 Feb 2018 15:34:50 -0600 Subject: [PATCH 052/129] update translate (#871) i translate the todo line, and put some changes in a words of the service, I hope it helps, thanks. --- application/language/spanish/rest_controller_lang.php | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/application/language/spanish/rest_controller_lang.php b/application/language/spanish/rest_controller_lang.php index 2ca81056..d96c62bc 100644 --- a/application/language/spanish/rest_controller_lang.php +++ b/application/language/spanish/rest_controller_lang.php @@ -4,15 +4,15 @@ * Spanish language */ -$lang['text_rest_invalid_api_key'] = 'API key %s No valida'; // %s is the REST API key -$lang['text_rest_invalid_credentials'] = 'Credenciales Invalidas'; +$lang['text_rest_invalid_api_key'] = 'API key %s No válida'; // %s is the REST API key +$lang['text_rest_invalid_credentials'] = 'Credenciales Inválidas'; $lang['text_rest_ip_denied'] = 'IP denegada'; $lang['text_rest_ip_unauthorized'] = 'IP no autorizada'; $lang['text_rest_unauthorized'] = 'Acceso no autorizado'; -$lang['text_rest_ajax_only'] = 'Solo peticiones ajax permitidas'; +$lang['text_rest_ajax_only'] = 'Sólo peticiones ajax permitidas'; $lang['text_rest_api_key_unauthorized'] = 'Esta clave de API no tiene acceso al controlador solicitado'; $lang['text_rest_api_key_permissions'] = 'Esta clave de API no tiene suficientes permisos'; $lang['text_rest_api_key_time_limit'] = 'Esta clave de API ha alcanzado el límite de tiempo para este método'; -$lang['text_rest_ip_address_time_limit'] = 'This IP Address has reached the time limit for this method';//todo translate -$lang['text_rest_unknown_method'] = 'método desconocido'; +$lang['text_rest_ip_address_time_limit'] = 'Esta dirección IP ha alcanzado el límite de tiempo para este método';//todo translate +$lang['text_rest_unknown_method'] = 'Método desconocido'; $lang['text_rest_unsupported'] = 'Protocolo no soportado'; From 579885ac21123ecfe007de46f6686a584a198ec2 Mon Sep 17 00:00:00 2001 From: Jason Gegere Date: Tue, 27 Feb 2018 15:35:31 -0600 Subject: [PATCH 053/129] load rest config, correct missing vars - Migrations (#820) (#897) --- application/migrations/20170706030520_create_table_api_keys.php | 1 + application/migrations/20170706031435_create_table_api_logs.php | 1 + .../migrations/20170706032133_create_table_api_access.php | 1 + .../migrations/20170706032825_create_table_api_limits.php | 1 + 4 files changed, 4 insertions(+) diff --git a/application/migrations/20170706030520_create_table_api_keys.php b/application/migrations/20170706030520_create_table_api_keys.php index d579614d..8c3954d8 100644 --- a/application/migrations/20170706030520_create_table_api_keys.php +++ b/application/migrations/20170706030520_create_table_api_keys.php @@ -15,6 +15,7 @@ class Migration_create_table_api_keys extends CI_Migration { public function up() { + $this->config->load('rest'); $table = config_item('rest_keys_table'); $fields = array( 'id' => [ diff --git a/application/migrations/20170706031435_create_table_api_logs.php b/application/migrations/20170706031435_create_table_api_logs.php index bb52b866..03d6a567 100644 --- a/application/migrations/20170706031435_create_table_api_logs.php +++ b/application/migrations/20170706031435_create_table_api_logs.php @@ -15,6 +15,7 @@ class Migration_create_table_api_logs extends CI_Migration { public function up() { + $this->config->load('rest'); $table = config_item('rest_logs_table'); $fields = array( 'id' => [ diff --git a/application/migrations/20170706032133_create_table_api_access.php b/application/migrations/20170706032133_create_table_api_access.php index ac863756..c78cbe3f 100644 --- a/application/migrations/20170706032133_create_table_api_access.php +++ b/application/migrations/20170706032133_create_table_api_access.php @@ -15,6 +15,7 @@ class Migration_create_table_api_access extends CI_Migration { public function up() { + $this->config->load('rest'); $table = config_item('rest_access_table'); $fields = array( 'id' => [ diff --git a/application/migrations/20170706032825_create_table_api_limits.php b/application/migrations/20170706032825_create_table_api_limits.php index fdbff1ff..28f211bd 100644 --- a/application/migrations/20170706032825_create_table_api_limits.php +++ b/application/migrations/20170706032825_create_table_api_limits.php @@ -15,6 +15,7 @@ class Migration_create_table_api_limits extends CI_Migration { public function up() { + $this->config->load('rest'); $table = config_item('rest_limits_table'); $fields = array( 'id' => [ From 2c1c621ca79ff91a4a3f5bbe1c7aa6748b56ad27 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mattias=20Sandstr=C3=B6m?= <1013635+tangix@users.noreply.github.com> Date: Thu, 8 Mar 2018 20:39:58 +0100 Subject: [PATCH 054/129] Add config to force CORS pre-flight headers to be included (#886) * Added config option to force setting of CORS pre-flight headers. * Updated the setting to be empty by default and updated the comment. --- application/config/rest.php | 21 +++++++++++++++++++++ application/libraries/REST_Controller.php | 9 +++++++++ 2 files changed, 30 insertions(+) diff --git a/application/config/rest.php b/application/config/rest.php index cdb92bf4..18327360 100644 --- a/application/config/rest.php +++ b/application/config/rest.php @@ -604,3 +604,24 @@ | */ $config['allowed_cors_origins'] = []; + +/* +|-------------------------------------------------------------------------- +| CORS Forced Headers +|-------------------------------------------------------------------------- +| +| If using CORS checks, always include the headers and values specified here +| in the OPTIONS client preflight. +| Example: +| $config['forced_cors_headers'] = [ +| 'Access-Control-Allow-Credentials' => 'true' +| ]; +| +| Added because of how Sencha Ext JS framework requires the header +| Access-Control-Allow-Credentials to be set to true to allow the use of +| credentials in the REST Proxy. +| See documentation here: +| http://docs.sencha.com/extjs/6.5.2/classic/Ext.data.proxy.Rest.html#cfg-withCredentials +| +*/ +$config['forced_cors_headers'] = []; diff --git a/application/libraries/REST_Controller.php b/application/libraries/REST_Controller.php index 17c35388..dfacaabf 100644 --- a/application/libraries/REST_Controller.php +++ b/application/libraries/REST_Controller.php @@ -2333,6 +2333,15 @@ protected function _check_cors() } } + // If there are headers that should be forced in the CORS check, add them now + if (is_array($this->config->item('forced_cors_headers'))) + { + foreach ($this->config->item('forced_cors_headers') as $header => $value) + { + header($header . ': ' . $value); + } + } + // If the request HTTP method is 'OPTIONS', kill the response and send it to the client if ($this->input->method() === 'options') { From d70785d802a6361d268c7165f37b8cdf7d8b09e1 Mon Sep 17 00:00:00 2001 From: _bolek_ Date: Sat, 2 Jun 2018 22:50:51 +0200 Subject: [PATCH 055/129] Update composer.json (#922) Thanks to this namespace will work for classes (with few changens in Format.php and Rest_controller.php) --- composer.json | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/composer.json b/composer.json index a4b9f670..637f86f8 100644 --- a/composer.json +++ b/composer.json @@ -21,6 +21,9 @@ "classmap": [ "application/libraries/Format.php", "application/libraries/REST_Controller.php" - ] + ], + "psr-4" : { + "Restserver\\Libraries\\" : "application/libraries/" + } } -} \ No newline at end of file +} From d03f6141794fbf8ee1e011f24090ddbae9530fb1 Mon Sep 17 00:00:00 2001 From: _bolek_ Date: Sat, 2 Jun 2018 22:51:08 +0200 Subject: [PATCH 056/129] Patch 2 (#923) * Update Format.php Allow access to class witch USE statement * Update Format.php Remove notification "Non-static method ... should not be called statically" --- application/libraries/Format.php | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/application/libraries/Format.php b/application/libraries/Format.php index 60a83a35..5ecb63f7 100644 --- a/application/libraries/Format.php +++ b/application/libraries/Format.php @@ -1,4 +1,6 @@ Date: Sat, 2 Jun 2018 22:51:34 +0200 Subject: [PATCH 057/129] Update REST_Controller.php (#924) Support for namespece --- application/libraries/REST_Controller.php | 36 +++++++++++++---------- 1 file changed, 21 insertions(+), 15 deletions(-) diff --git a/application/libraries/REST_Controller.php b/application/libraries/REST_Controller.php index dfacaabf..8c7501df 100644 --- a/application/libraries/REST_Controller.php +++ b/application/libraries/REST_Controller.php @@ -1,5 +1,10 @@ get_local_config($config); // At present the library is bundled with REST_Controller 2.5+, but will eventually be part of CodeIgniter (no citation) - if(class_exists('Format')) - { - $this->format = new Format(); - } - else - { - $this->load->library('Format', NULL, 'libraryFormat'); - $this->format = $this->libraryFormat; - } + //if(class_exists('Format')) + //{ + // $this->format = new Format(); + //} + //else + //{ + // $this->load->library('Format', NULL, 'libraryFormat'); + // $this->format = $this->libraryFormat; + //} // Determine supported output formats from configuration @@ -505,8 +510,9 @@ public function __construct($config = 'rest') // Now we know all about our request, let's try and parse the body if it exists if ($this->request->format && $this->request->body) { - $this->request->body = $this->format->factory($this->request->body, $this->request->format)->to_array(); - // Assign payload arguments to proper method container + $this->request->body = Format::factory($this->request->body, $this->request->format)->to_array(); + + // Assign payload arguments to proper method container $this->{'_'.$this->request->method.'_args'} = $this->request->body; } @@ -840,17 +846,17 @@ public function response($data = NULL, $http_code = NULL, $continue = FALSE) elseif ($data !== NULL) { // If the format method exists, call and return the output in that format - if (method_exists($this->format, 'to_' . $this->response->format)) + if (method_exists(Format::class, 'to_' . $this->response->format)) { // Set the format header $this->output->set_content_type($this->_supported_formats[$this->response->format], strtolower($this->config->item('charset'))); - $output = $this->format->factory($data)->{'to_' . $this->response->format}(); + $output = Format::factory($data)->{'to_' . $this->response->format}(); // An array must be parsed as a string, so as not to cause an array to string error // Json is the most appropriate form for such a data type if ($this->response->format === 'array') { - $output = $this->format->factory($output)->{'to_json'}(); + $output = Format::factory($output)->{'to_json'}(); } } else @@ -858,7 +864,7 @@ public function response($data = NULL, $http_code = NULL, $continue = FALSE) // If an array or object, then parse as a json, so as to be a 'string' if (is_array($data) || is_object($data)) { - $data = $this->format->factory($data)->{'to_json'}(); + $data = Format::factory($data)->{'to_json'}(); } // Format is not supported, so output the raw data as a string From bc73533a57c14c2973aa359b74d5e612da328512 Mon Sep 17 00:00:00 2001 From: _bolek_ Date: Sat, 2 Jun 2018 22:51:47 +0200 Subject: [PATCH 058/129] Update Example.php (#925) --- application/controllers/api/Example.php | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/application/controllers/api/Example.php b/application/controllers/api/Example.php index eb2f9069..7978ce4c 100644 --- a/application/controllers/api/Example.php +++ b/application/controllers/api/Example.php @@ -1,10 +1,10 @@ Date: Sat, 2 Jun 2018 22:52:25 +0200 Subject: [PATCH 059/129] Update Key.php (#926) --- application/controllers/api/Key.php | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/application/controllers/api/Key.php b/application/controllers/api/Key.php index 547334b6..8f3a64b4 100644 --- a/application/controllers/api/Key.php +++ b/application/controllers/api/Key.php @@ -1,10 +1,11 @@ Date: Tue, 31 Jul 2018 01:42:13 +0300 Subject: [PATCH 060/129] Patch 1 (#939) * Update Example.php Fix File REST_Controller not found problem * Update REST_Controller.php Class 'Restserver\Libraries\CI_Controller' not found --- application/controllers/api/Example.php | 4 +++- application/libraries/REST_Controller.php | 2 +- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/application/controllers/api/Example.php b/application/controllers/api/Example.php index 7978ce4c..9bc3a828 100644 --- a/application/controllers/api/Example.php +++ b/application/controllers/api/Example.php @@ -4,7 +4,9 @@ // This can be removed if you use __autoload() in config.php OR use Modular Extensions /** @noinspection PhpIncludeInspection */ -//require APPPATH . 'libraries/REST_Controller.php'; +//To Solve File REST_Controller not found +require APPPATH . 'libraries/REST_Controller.php'; +require APPPATH . 'libraries/Format.php'; /** * This is an example of a few basic user interaction methods you could use diff --git a/application/libraries/REST_Controller.php b/application/libraries/REST_Controller.php index 8c7501df..5dda5564 100644 --- a/application/libraries/REST_Controller.php +++ b/application/libraries/REST_Controller.php @@ -1,7 +1,7 @@ Date: Thu, 20 Sep 2018 05:59:31 -1000 Subject: [PATCH 061/129] Move output format detection upwards (#947) to allow responses earlier, i.e. when handling exceptions, which might be thrown in Format::factory, in a REST_Controller subclass. --- application/libraries/REST_Controller.php | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/application/libraries/REST_Controller.php b/application/libraries/REST_Controller.php index 5dda5564..13f79ef4 100644 --- a/application/libraries/REST_Controller.php +++ b/application/libraries/REST_Controller.php @@ -507,6 +507,12 @@ public function __construct($config = 'rest') $this->{'_'.$this->request->method.'_args'} = []; } + // Which format should the data be returned in? + $this->response->format = $this->_detect_output_format(); + + // Which language should the data be returned in? + $this->response->lang = $this->_detect_lang(); + // Now we know all about our request, let's try and parse the body if it exists if ($this->request->format && $this->request->body) { @@ -531,12 +537,6 @@ public function __construct($config = 'rest') $this->{'_'.$this->request->method.'_args'} ); - // Which format should the data be returned in? - $this->response->format = $this->_detect_output_format(); - - // Which language should the data be returned in? - $this->response->lang = $this->_detect_lang(); - // Extend this function to apply additional checking early on in the process $this->early_checks(); From d51e373ff151e3b7ed1aefbb6addb40fcedfaf17 Mon Sep 17 00:00:00 2001 From: "Januri D. P" Date: Fri, 9 Nov 2018 19:33:01 +0700 Subject: [PATCH 062/129] Update rest_controller_lang.php (#955) --- application/language/indonesia/rest_controller_lang.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/application/language/indonesia/rest_controller_lang.php b/application/language/indonesia/rest_controller_lang.php index 771c6835..9931e18b 100644 --- a/application/language/indonesia/rest_controller_lang.php +++ b/application/language/indonesia/rest_controller_lang.php @@ -1,7 +1,7 @@ Date: Tue, 1 Jan 2019 10:45:39 +0800 Subject: [PATCH 063/129] Enhance: log execute time (#965) --- application/libraries/REST_Controller.php | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/application/libraries/REST_Controller.php b/application/libraries/REST_Controller.php index 13f79ef4..0e936788 100644 --- a/application/libraries/REST_Controller.php +++ b/application/libraries/REST_Controller.php @@ -405,8 +405,12 @@ public function __construct($config = 'rest') // when output is displayed for not damaging data accidentally $this->output->parse_exec_vars = FALSE; - // Start the timer for how long the request takes - $this->_start_rtime = microtime(TRUE); + // Log the loading time to the log table + if ($this->config->item('rest_enable_logging') === TRUE) + { + // Start the timer for how long the request takes + $this->_start_rtime = microtime(TRUE); + } // Load the rest.php configuration file $this->get_local_config($config); @@ -626,12 +630,12 @@ private function get_local_config($config_file) */ public function __destruct() { - // Get the current timestamp - $this->_end_rtime = microtime(TRUE); - // Log the loading time to the log table if ($this->config->item('rest_enable_logging') === TRUE) { + // Get the current timestamp + $this->_end_rtime = microtime(TRUE); + $this->_log_access_time(); } } From 5877df4599967d893e19bc1957cc1a9c5618c245 Mon Sep 17 00:00:00 2001 From: Mofasa Date: Tue, 1 Jan 2019 10:46:17 +0800 Subject: [PATCH 064/129] Enhance: redundant _check_whitelist_auth checking (#966) --- application/libraries/REST_Controller.php | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/application/libraries/REST_Controller.php b/application/libraries/REST_Controller.php index 0e936788..256f16e2 100644 --- a/application/libraries/REST_Controller.php +++ b/application/libraries/REST_Controller.php @@ -595,10 +595,6 @@ public function __construct($config = 'rest') $this->_check_php_session(); break; } - if ($this->config->item('rest_ip_whitelist_enabled') === TRUE) - { - $this->_check_whitelist_auth(); - } } } @@ -2021,6 +2017,12 @@ protected function _check_login($username = NULL, $password = FALSE) */ protected function _check_php_session() { + // If whitelist is enabled it has the first chance to kick them out + if ($this->config->item('rest_ip_whitelist_enabled')) + { + $this->_check_whitelist_auth(); + } + // Get the auth_source config item $key = $this->config->item('auth_source'); From 3b82afc9afb8134e4e7be789a370cf1cc2068a17 Mon Sep 17 00:00:00 2001 From: Mofasa Date: Tue, 1 Jan 2019 10:46:45 +0800 Subject: [PATCH 065/129] Enhance: no need to access db check twice (#967) --- application/libraries/REST_Controller.php | 28 ++++++++++------------- 1 file changed, 12 insertions(+), 16 deletions(-) diff --git a/application/libraries/REST_Controller.php b/application/libraries/REST_Controller.php index 256f16e2..3c83ae03 100644 --- a/application/libraries/REST_Controller.php +++ b/application/libraries/REST_Controller.php @@ -2279,16 +2279,6 @@ protected function _check_access() return TRUE; } - //check if the key has all_access - $accessRow = $this->rest->db - ->where('key', $this->rest->key) - ->get($this->config->item('rest_access_table'))->row_array(); - - if (!empty($accessRow) && !empty($accessRow['all_access'])) - { - return TRUE; - } - // Fetch controller based on path and controller name $controller = implode( '/', [ @@ -2299,12 +2289,18 @@ protected function _check_access() // Remove any double slashes for safety $controller = str_replace('//', '/', $controller); - // Query the access table and get the number of results - return $this->rest->db - ->where('key', $this->rest->key) - ->where('controller', $controller) - ->get($this->config->item('rest_access_table')) - ->num_rows() > 0; + //check if the key has all_access + $accessRow = $this->rest->db + ->where('key', $this->rest->key) + ->where('controller', $controller) + ->get($this->config->item('rest_access_table'))->row_array(); + + if (!empty($accessRow) && !empty($accessRow['all_access'])) + { + return TRUE; + } + + return false; } /** From aca82471a2406e05ff846b2140a89342967c5f17 Mon Sep 17 00:00:00 2001 From: Mofasa Date: Tue, 1 Jan 2019 10:47:27 +0800 Subject: [PATCH 066/129] Remove death code (#968) --- application/libraries/REST_Controller.php | 14 -------------- 1 file changed, 14 deletions(-) diff --git a/application/libraries/REST_Controller.php b/application/libraries/REST_Controller.php index 3c83ae03..06d915b8 100644 --- a/application/libraries/REST_Controller.php +++ b/application/libraries/REST_Controller.php @@ -677,8 +677,6 @@ public function _remap($object_called, $arguments = []) $this->config->item('rest_status_field_name') => FALSE, $this->config->item('rest_message_field_name') => $this->lang->line('text_rest_unsupported') ], self::HTTP_FORBIDDEN); - - $this->is_valid_request = false; } // Remove the supported format from the function name e.g. index.json => index @@ -714,8 +712,6 @@ public function _remap($object_called, $arguments = []) $this->config->item('rest_status_field_name') => FALSE, $this->config->item('rest_message_field_name') => sprintf($this->lang->line('text_rest_invalid_api_key'), $this->rest->key) ], self::HTTP_FORBIDDEN); - - $this->is_valid_request = false; } // Check to see if this key has access to the requested controller @@ -730,8 +726,6 @@ public function _remap($object_called, $arguments = []) $this->config->item('rest_status_field_name') => FALSE, $this->config->item('rest_message_field_name') => $this->lang->line('text_rest_api_key_unauthorized') ], self::HTTP_UNAUTHORIZED); - - $this->is_valid_request = false; } // Sure it exists, but can they do anything with it? @@ -741,8 +735,6 @@ public function _remap($object_called, $arguments = []) $this->config->item('rest_status_field_name') => FALSE, $this->config->item('rest_message_field_name') => $this->lang->line('text_rest_unknown_method') ], self::HTTP_METHOD_NOT_ALLOWED); - - $this->is_valid_request = false; } // Doing key related stuff? Can only do it if they have a key right? @@ -753,8 +745,6 @@ public function _remap($object_called, $arguments = []) { $response = [$this->config->item('rest_status_field_name') => FALSE, $this->config->item('rest_message_field_name') => $this->lang->line('text_rest_api_key_time_limit')]; $this->response($response, self::HTTP_UNAUTHORIZED); - - $this->is_valid_request = false; } // If no level is set use 0, they probably aren't using permissions @@ -772,8 +762,6 @@ public function _remap($object_called, $arguments = []) // They don't have good enough perms $response = [$this->config->item('rest_status_field_name') => FALSE, $this->config->item('rest_message_field_name') => $this->lang->line('text_rest_api_key_permissions')]; $this->response($response, self::HTTP_UNAUTHORIZED); - - $this->is_valid_request = false; } } @@ -782,8 +770,6 @@ public function _remap($object_called, $arguments = []) { $response = [$this->config->item('rest_status_field_name') => FALSE, $this->config->item('rest_message_field_name') => $this->lang->line('text_rest_ip_address_time_limit')]; $this->response($response, self::HTTP_UNAUTHORIZED); - - $this->is_valid_request = false; } // No key stuff, but record that stuff is happening From 03383563745de74b792b577ba6d5020f9638604e Mon Sep 17 00:00:00 2001 From: Mofasa Date: Tue, 1 Jan 2019 10:48:02 +0800 Subject: [PATCH 067/129] minus enhancement (#969) --- application/libraries/REST_Controller.php | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/application/libraries/REST_Controller.php b/application/libraries/REST_Controller.php index 06d915b8..bfa4a4a2 100644 --- a/application/libraries/REST_Controller.php +++ b/application/libraries/REST_Controller.php @@ -1104,11 +1104,12 @@ protected function _detect_api_key() { // multiple ip addresses must be separated using a comma, explode and loop $list_ip_addresses = explode(',', $row->ip_addresses); + $ip_address = $this->input->ip_address(); $found_address = FALSE; foreach ($list_ip_addresses as $ip_address) { - if ($this->input->ip_address() === trim($ip_address)) + if ($ip_address === trim($ip_address)) { // there is a match, set the the value to TRUE and break out of the loop $found_address = TRUE; @@ -1215,8 +1216,8 @@ protected function _check_limit($controller_method) switch ($this->config->item('rest_limits_method')) { case 'IP_ADDRESS': - $limited_uri = 'ip-address:' .$this->input->ip_address(); $api_key = $this->input->ip_address(); + $limited_uri = 'ip-address:' . $api_key; break; case 'API_KEY': @@ -2181,14 +2182,14 @@ protected function _check_whitelist_auth() */ protected function _force_login($nonce = '') { - $rest_auth = $this->config->item('rest_auth'); + $rest_auth = strtolower($this->config->item('rest_auth')); $rest_realm = $this->config->item('rest_realm'); - if (strtolower($rest_auth) === 'basic') + if ($rest_auth === 'basic') { // See http://tools.ietf.org/html/rfc2617#page-5 header('WWW-Authenticate: Basic realm="'.$rest_realm.'"'); } - elseif (strtolower($rest_auth) === 'digest') + elseif ($rest_auth === 'digest') { // See http://tools.ietf.org/html/rfc2617#page-18 header( From f3ba7d76cb14c11602f72b432926a17b8ff7c590 Mon Sep 17 00:00:00 2001 From: Mofasa Date: Mon, 7 Jan 2019 12:50:14 +0800 Subject: [PATCH 068/129] bugfix --- application/libraries/REST_Controller.php | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/application/libraries/REST_Controller.php b/application/libraries/REST_Controller.php index bfa4a4a2..2691aff7 100644 --- a/application/libraries/REST_Controller.php +++ b/application/libraries/REST_Controller.php @@ -2102,8 +2102,7 @@ protected function _prepare_digest_auth() $digest = (empty($matches[1]) || empty($matches[2])) ? [] : array_combine($matches[1], $matches[2]); // For digest authentication the library function should return already stored md5(username:restrealm:password) for that username see rest.php::auth_library_function config - $username = $this->_check_login($digest['username'], TRUE); - if (array_key_exists('username', $digest) === FALSE || $username === FALSE) + if (isset($digest['username']) === FALSE || $this->_check_login($digest['username'], TRUE) === FALSE) { $this->_force_login($unique_id); } From 570d4579c4ccfeeacc6204f421616ce364fbafe2 Mon Sep 17 00:00:00 2001 From: B0mb3tt4 Date: Tue, 15 Jan 2019 23:56:24 +0100 Subject: [PATCH 069/129] MD5 Response fix --- application/libraries/REST_Controller.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/application/libraries/REST_Controller.php b/application/libraries/REST_Controller.php index 2691aff7..2363cfc4 100644 --- a/application/libraries/REST_Controller.php +++ b/application/libraries/REST_Controller.php @@ -2108,7 +2108,7 @@ protected function _prepare_digest_auth() } $md5 = md5(strtoupper($this->request->method).':'.$digest['uri']); - $valid_response = md5($username.':'.$digest['nonce'].':'.$digest['nc'].':'.$digest['cnonce'].':'.$digest['qop'].':'.$md5); + $valid_response = md5($digest['username'].':'.$digest['nonce'].':'.$digest['nc'].':'.$digest['cnonce'].':'.$digest['qop'].':'.$md5); // Check if the string don't compare (case-insensitive) if (strcasecmp($digest['response'], $valid_response) !== 0) From 359c2f84503b67eec0863cfc38848e5ab5ae74d4 Mon Sep 17 00:00:00 2001 From: rsmnarts <40693945+rsmnarts@users.noreply.github.com> Date: Wed, 20 Feb 2019 13:25:03 +0700 Subject: [PATCH 070/129] rename $this->method to $this-methods --- application/config/rest.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/application/config/rest.php b/application/config/rest.php index 18327360..109cb671 100644 --- a/application/config/rest.php +++ b/application/config/rest.php @@ -483,7 +483,7 @@ | To specify the limits within the controller's __construct() method, add per-method | limits with: | -| $this->method['METHOD_NAME']['limit'] = [NUM_REQUESTS_PER_HOUR]; +| $this->methods['METHOD_NAME']['limit'] = [NUM_REQUESTS_PER_HOUR]; | | See application/controllers/api/example.php for examples */ From 2bb2fe4808cdf4f591ca55f480884909e026fbd1 Mon Sep 17 00:00:00 2001 From: CodeLingoBot Date: Mon, 1 Apr 2019 10:49:35 +1300 Subject: [PATCH 071/129] Fix case of contants based on best practices from PSR2 Signed-off-by: CodeLingoBot --- application/config/ldap.php | 2 +- application/config/profiler.php | 22 ++++++------ application/config/rest.php | 34 +++++++++---------- application/config/routes.php | 2 +- application/controllers/api/Example.php | 12 +++---- application/controllers/api/Key.php | 28 +++++++-------- .../20170706025420_create_table_users.php | 10 +++--- .../20170706030520_create_table_api_keys.php | 12 +++---- .../20170706031435_create_table_api_logs.php | 12 +++---- ...20170706032133_create_table_api_access.php | 8 ++--- ...20170706032825_create_table_api_limits.php | 6 ++-- 11 files changed, 74 insertions(+), 74 deletions(-) diff --git a/application/config/ldap.php b/application/config/ldap.php index e4165550..a54b985d 100644 --- a/application/config/ldap.php +++ b/application/config/ldap.php @@ -8,7 +8,7 @@ * There will be a delay while the code times out trying to talk to the main server but things will still work. */ $config['server'] = 'ldapserver1.example.org ldapserver2.example.org'; -$config['port'] = NULL; +$config['port'] = null; /* * Controls the LDAP_OPT_NETWORK_TIMEOUT option, this is how long the code will attempt to talk to the primary server if it is unreachable. */ diff --git a/application/config/profiler.php b/application/config/profiler.php index ce026a7e..870880d9 100644 --- a/application/config/profiler.php +++ b/application/config/profiler.php @@ -12,15 +12,15 @@ | http://codeigniter.com/user_guide/general/profiling.html | */ -$config['benchmarks'] = TRUE; -$config['config'] = TRUE; -$config['controller_info'] = TRUE; -$config['get'] = TRUE; -$config['http_headers'] = TRUE; -$config['memory_usage'] = TRUE; -$config['post'] = TRUE; -$config['queries'] = TRUE; -$config['eloquent'] = FALSE; -$config['uri_string'] = TRUE; -$config['view_data'] = TRUE; +$config['benchmarks'] = true; +$config['config'] = true; +$config['controller_info'] = true; +$config['get'] = true; +$config['http_headers'] = true; +$config['memory_usage'] = true; +$config['post'] = true; +$config['queries'] = true; +$config['eloquent'] = false; +$config['uri_string'] = true; +$config['view_data'] = true; $config['query_toggle_count'] = 1000; \ No newline at end of file diff --git a/application/config/rest.php b/application/config/rest.php index 109cb671..394937ce 100644 --- a/application/config/rest.php +++ b/application/config/rest.php @@ -10,7 +10,7 @@ | Set to force the use of HTTPS for REST API calls | */ -$config['force_https'] = FALSE; +$config['force_https'] = false; /* |-------------------------------------------------------------------------- @@ -82,7 +82,7 @@ | Should we enable emulation of the request (e.g. used in Mootools request) | */ -$config['enable_emulate_request'] = TRUE; +$config['enable_emulate_request'] = true; /* |-------------------------------------------------------------------------- @@ -110,7 +110,7 @@ | authorization key | */ -$config['rest_auth'] = FALSE; +$config['rest_auth'] = false; /* |-------------------------------------------------------------------------- @@ -137,8 +137,8 @@ | requests etc), set to TRUE; | */ -$config['allow_auth_and_keys'] = TRUE; -$config['strict_api_and_auth'] = TRUE; // force the use of both api and auth before a valid api request is made +$config['allow_auth_and_keys'] = true; +$config['strict_api_and_auth'] = true; // force the use of both api and auth before a valid api request is made /* |-------------------------------------------------------------------------- @@ -228,7 +228,7 @@ | restrict certain methods to IPs in your white-list | */ -$config['rest_ip_whitelist_enabled'] = FALSE; +$config['rest_ip_whitelist_enabled'] = false; /* |-------------------------------------------------------------------------- @@ -238,7 +238,7 @@ | Handle exceptions caused by the controller | */ -$config['rest_handle_exceptions'] = TRUE; +$config['rest_handle_exceptions'] = true; /* |-------------------------------------------------------------------------- @@ -266,7 +266,7 @@ | 1. Set to TRUE and add any IP address to 'rest_ip_blacklist' | */ -$config['rest_ip_blacklist_enabled'] = FALSE; +$config['rest_ip_blacklist_enabled'] = false; /* |-------------------------------------------------------------------------- @@ -324,7 +324,7 @@ | ) ENGINE=InnoDB DEFAULT CHARSET=utf8; | */ -$config['rest_enable_keys'] = FALSE; +$config['rest_enable_keys'] = false; /* |-------------------------------------------------------------------------- @@ -404,7 +404,7 @@ | ) ENGINE=InnoDB DEFAULT CHARSET=utf8; | */ -$config['rest_enable_logging'] = FALSE; +$config['rest_enable_logging'] = false; /* |-------------------------------------------------------------------------- @@ -437,7 +437,7 @@ | ) ENGINE=InnoDB DEFAULT CHARSET=utf8; | */ -$config['rest_enable_access'] = FALSE; +$config['rest_enable_access'] = false; /* |-------------------------------------------------------------------------- @@ -459,7 +459,7 @@ | Set to FALSE to log as serialized PHP | */ -$config['rest_logs_json_params'] = FALSE; +$config['rest_logs_json_params'] = false; /* |-------------------------------------------------------------------------- @@ -487,7 +487,7 @@ | | See application/controllers/api/example.php for examples */ -$config['rest_enable_limits'] = FALSE; +$config['rest_enable_limits'] = false; /* |-------------------------------------------------------------------------- @@ -509,7 +509,7 @@ | Only do this if you are using the $this->rest_format or /format/xml in URLs | */ -$config['rest_ignore_http_accept'] = FALSE; +$config['rest_ignore_http_accept'] = false; /* |-------------------------------------------------------------------------- @@ -524,7 +524,7 @@ | Hint: This is good for production environments | */ -$config['rest_ajax_only'] = FALSE; +$config['rest_ajax_only'] = false; /* |-------------------------------------------------------------------------- @@ -546,7 +546,7 @@ | will access it through a browser | */ -$config['check_cors'] = FALSE; +$config['check_cors'] = false; /* |-------------------------------------------------------------------------- @@ -590,7 +590,7 @@ | source domain | */ -$config['allow_any_cors_domain'] = FALSE; +$config['allow_any_cors_domain'] = false; /* |-------------------------------------------------------------------------- diff --git a/application/config/routes.php b/application/config/routes.php index f2d051f7..c0f8cee9 100644 --- a/application/config/routes.php +++ b/application/config/routes.php @@ -51,7 +51,7 @@ */ $route['default_controller'] = 'welcome'; $route['404_override'] = ''; -$route['translate_uri_dashes'] = TRUE; +$route['translate_uri_dashes'] = true; /* | ------------------------------------------------------------------------- diff --git a/application/controllers/api/Example.php b/application/controllers/api/Example.php index 9bc3a828..3b6de553 100644 --- a/application/controllers/api/Example.php +++ b/application/controllers/api/Example.php @@ -46,7 +46,7 @@ public function users_get() // If the id parameter doesn't exist return all the users - if ($id === NULL) + if ($id === null) { // Check if the users data store contains users (in case the database result returns NULL) if ($users) @@ -58,7 +58,7 @@ public function users_get() { // Set the response and exit $this->response([ - 'status' => FALSE, + 'status' => false, 'message' => 'No users were found' ], REST_Controller::HTTP_NOT_FOUND); // NOT_FOUND (404) being the HTTP response code } @@ -72,13 +72,13 @@ public function users_get() if ($id <= 0) { // Invalid id, set the response and exit. - $this->response(NULL, REST_Controller::HTTP_BAD_REQUEST); // BAD_REQUEST (400) being the HTTP response code + $this->response(null, REST_Controller::HTTP_BAD_REQUEST); // BAD_REQUEST (400) being the HTTP response code } // Get the user from the array, using the id as key for retrieval. // Usually a model is to be used for this. - $user = NULL; + $user = null; if (!empty($users)) { @@ -98,7 +98,7 @@ public function users_get() else { $this->set_response([ - 'status' => FALSE, + 'status' => false, 'message' => 'User could not be found' ], REST_Controller::HTTP_NOT_FOUND); // NOT_FOUND (404) being the HTTP response code } @@ -125,7 +125,7 @@ public function users_delete() if ($id <= 0) { // Set the response and exit - $this->response(NULL, REST_Controller::HTTP_BAD_REQUEST); // BAD_REQUEST (400) being the HTTP response code + $this->response(null, REST_Controller::HTTP_BAD_REQUEST); // BAD_REQUEST (400) being the HTTP response code } // $this->some_model->delete_something($id); diff --git a/application/controllers/api/Key.php b/application/controllers/api/Key.php index 8f3a64b4..585f9f60 100644 --- a/application/controllers/api/Key.php +++ b/application/controllers/api/Key.php @@ -46,14 +46,14 @@ public function index_put() if ($this->_insert_key($key, ['level' => $level, 'ignore_limits' => $ignore_limits])) { $this->response([ - 'status' => TRUE, + 'status' => true, 'key' => $key ], REST_Controller::HTTP_CREATED); // CREATED (201) being the HTTP response code } else { $this->response([ - 'status' => FALSE, + 'status' => false, 'message' => 'Could not save the key' ], REST_Controller::HTTP_INTERNAL_SERVER_ERROR); // INTERNAL_SERVER_ERROR (500) being the HTTP response code } @@ -74,7 +74,7 @@ public function index_delete() { // It doesn't appear the key exists $this->response([ - 'status' => FALSE, + 'status' => false, 'message' => 'Invalid API key' ], REST_Controller::HTTP_BAD_REQUEST); // BAD_REQUEST (400) being the HTTP response code } @@ -84,7 +84,7 @@ public function index_delete() // Respond that the key was destroyed $this->response([ - 'status' => TRUE, + 'status' => true, 'message' => 'API key was deleted' ], REST_Controller::HTTP_NO_CONTENT); // NO_CONTENT (204) being the HTTP response code } @@ -105,7 +105,7 @@ public function level_post() { // It doesn't appear the key exists $this->response([ - 'status' => FALSE, + 'status' => false, 'message' => 'Invalid API key' ], REST_Controller::HTTP_BAD_REQUEST); // BAD_REQUEST (400) being the HTTP response code } @@ -114,14 +114,14 @@ public function level_post() if ($this->_update_key($key, ['level' => $new_level])) { $this->response([ - 'status' => TRUE, + 'status' => true, 'message' => 'API key was updated' ], REST_Controller::HTTP_OK); // OK (200) being the HTTP response code } else { $this->response([ - 'status' => FALSE, + 'status' => false, 'message' => 'Could not update the key level' ], REST_Controller::HTTP_INTERNAL_SERVER_ERROR); // INTERNAL_SERVER_ERROR (500) being the HTTP response code } @@ -142,7 +142,7 @@ public function suspend_post() { // It doesn't appear the key exists $this->response([ - 'status' => FALSE, + 'status' => false, 'message' => 'Invalid API key' ], REST_Controller::HTTP_BAD_REQUEST); // BAD_REQUEST (400) being the HTTP response code } @@ -151,14 +151,14 @@ public function suspend_post() if ($this->_update_key($key, ['level' => 0])) { $this->response([ - 'status' => TRUE, + 'status' => true, 'message' => 'Key was suspended' ], REST_Controller::HTTP_OK); // OK (200) being the HTTP response code } else { $this->response([ - 'status' => FALSE, + 'status' => false, 'message' => 'Could not suspend the user' ], REST_Controller::HTTP_INTERNAL_SERVER_ERROR); // INTERNAL_SERVER_ERROR (500) being the HTTP response code } @@ -180,7 +180,7 @@ public function regenerate_post() { // It doesn't appear the key exists $this->response([ - 'status' => FALSE, + 'status' => false, 'message' => 'Invalid API key' ], REST_Controller::HTTP_BAD_REQUEST); // BAD_REQUEST (400) being the HTTP response code } @@ -195,14 +195,14 @@ public function regenerate_post() $this->_update_key($old_key, ['level' => 0]); $this->response([ - 'status' => TRUE, + 'status' => true, 'key' => $new_key ], REST_Controller::HTTP_CREATED); // CREATED (201) being the HTTP response code } else { $this->response([ - 'status' => FALSE, + 'status' => false, 'message' => 'Could not save the key' ], REST_Controller::HTTP_INTERNAL_SERVER_ERROR); // INTERNAL_SERVER_ERROR (500) being the HTTP response code } @@ -218,7 +218,7 @@ private function _generate_key() $salt = base_convert(bin2hex($this->security->get_random_bytes(64)), 16, 36); // If an error occurred, then fall back to the previous method - if ($salt === FALSE) + if ($salt === false) { $salt = hash('sha256', time() . mt_rand()); } diff --git a/application/migrations/20170706025420_create_table_users.php b/application/migrations/20170706025420_create_table_users.php index aaeccb69..3553dad3 100644 --- a/application/migrations/20170706025420_create_table_users.php +++ b/application/migrations/20170706025420_create_table_users.php @@ -21,12 +21,12 @@ public function up() $fields = array( 'id' => [ 'type' => 'INT(11)', - 'auto_increment' => TRUE, - 'unsigned' => TRUE, + 'auto_increment' => true, + 'unsigned' => true, ], 'email' => [ 'type' => 'VARCHAR(255)', - 'unique' => TRUE, + 'unique' => true, ], 'password' => [ 'type' => 'VARCHAR(64)', @@ -42,8 +42,8 @@ public function up() ], ); $this->dbforge->add_field($fields); - $this->dbforge->add_key('id', TRUE); - $this->dbforge->create_table($this->table, TRUE); + $this->dbforge->add_key('id', true); + $this->dbforge->create_table($this->table, true); /*for ($i = 1; $i <= 100; $i++) { diff --git a/application/migrations/20170706030520_create_table_api_keys.php b/application/migrations/20170706030520_create_table_api_keys.php index 8c3954d8..42fb5417 100644 --- a/application/migrations/20170706030520_create_table_api_keys.php +++ b/application/migrations/20170706030520_create_table_api_keys.php @@ -20,16 +20,16 @@ public function up() $fields = array( 'id' => [ 'type' => 'INT(11)', - 'auto_increment' => TRUE, - 'unsigned' => TRUE, + 'auto_increment' => true, + 'unsigned' => true, ], 'user_id' => [ 'type' => 'INT(11)', - 'unsigned' => TRUE, + 'unsigned' => true, ], config_item('rest_key_column') => [ 'type' => 'VARCHAR(' . config_item('rest_key_length') . ')', - 'unique' => TRUE, + 'unique' => true, ], 'level' => [ 'type' => 'INT(2)', @@ -44,14 +44,14 @@ public function up() ], 'ip_addresses' => [ 'type' => 'TEXT', - 'null' => TRUE, + 'null' => true, ], 'date_created' => [ 'type' => 'INT(11)', ], ); $this->dbforge->add_field($fields); - $this->dbforge->add_key('id', TRUE); + $this->dbforge->add_key('id', true); $this->dbforge->create_table($table); $this->db->query(add_foreign_key($table, 'user_id', 'users(id)', 'CASCADE', 'CASCADE')); } diff --git a/application/migrations/20170706031435_create_table_api_logs.php b/application/migrations/20170706031435_create_table_api_logs.php index 03d6a567..db8b4be4 100644 --- a/application/migrations/20170706031435_create_table_api_logs.php +++ b/application/migrations/20170706031435_create_table_api_logs.php @@ -20,8 +20,8 @@ public function up() $fields = array( 'id' => [ 'type' => 'INT(11)', - 'auto_increment' => TRUE, - 'unsigned' => TRUE, + 'auto_increment' => true, + 'unsigned' => true, ], 'api_key' => [ 'type' => 'VARCHAR(' . config_item('rest_key_length') . ')', @@ -34,7 +34,7 @@ public function up() ], 'params' => [ 'type' => 'TEXT', - 'null' => TRUE, + 'null' => true, ], 'ip_address' => [ 'type' => 'VARCHAR(45)', @@ -44,19 +44,19 @@ public function up() ], 'rtime' => [ 'type' => 'FLOAT', - 'null' => TRUE, + 'null' => true, ], 'authorized' => [ 'type' => 'VARCHAR(1)', ], 'response_code' => [ 'type' => 'SMALLINT(3)', - 'null' => TRUE, + 'null' => true, 'default' => 0, ], ); $this->dbforge->add_field($fields); - $this->dbforge->add_key('id', TRUE); + $this->dbforge->add_key('id', true); $this->dbforge->create_table($table); /*$this->db->query(add_foreign_key($table, 'api_key', config_item('rest_keys_table') . '(' . config_item('rest_key_column') . ')', 'CASCADE', 'CASCADE'));*/ diff --git a/application/migrations/20170706032133_create_table_api_access.php b/application/migrations/20170706032133_create_table_api_access.php index c78cbe3f..df004dda 100644 --- a/application/migrations/20170706032133_create_table_api_access.php +++ b/application/migrations/20170706032133_create_table_api_access.php @@ -20,8 +20,8 @@ public function up() $fields = array( 'id' => [ 'type' => 'INT(11)', - 'auto_increment' => TRUE, - 'unsigned' => TRUE, + 'auto_increment' => true, + 'unsigned' => true, ], 'key' => [ 'type' => 'VARCHAR(' . config_item('rest_key_length') . ')', @@ -35,14 +35,14 @@ public function up() ], 'date_created' => [ 'type' => 'DATETIME', - 'null' => TRUE, + 'null' => true, ], 'date_modified' => [ 'type' => 'TIMESTAMP', ], ); $this->dbforge->add_field($fields); - $this->dbforge->add_key('id', TRUE); + $this->dbforge->add_key('id', true); $this->dbforge->add_key('controller'); $this->dbforge->create_table($table); $this->db->query(add_foreign_key($table, 'key', diff --git a/application/migrations/20170706032825_create_table_api_limits.php b/application/migrations/20170706032825_create_table_api_limits.php index 28f211bd..c7355cb7 100644 --- a/application/migrations/20170706032825_create_table_api_limits.php +++ b/application/migrations/20170706032825_create_table_api_limits.php @@ -20,8 +20,8 @@ public function up() $fields = array( 'id' => [ 'type' => 'INT(11)', - 'auto_increment' => TRUE, - 'unsigned' => TRUE, + 'auto_increment' => true, + 'unsigned' => true, ], 'api_key' => [ 'type' => 'VARCHAR(' . config_item('rest_key_length') . ')', @@ -37,7 +37,7 @@ public function up() ], ); $this->dbforge->add_field($fields); - $this->dbforge->add_key('id', TRUE); + $this->dbforge->add_key('id', true); $this->dbforge->add_key('uri'); $this->dbforge->create_table($table); $this->db->query(add_foreign_key($table, 'api_key', From 6425ad60f7f108c1e52c2d939dd6b550a5e73a96 Mon Sep 17 00:00:00 2001 From: Kevin Hill Date: Tue, 14 May 2019 16:59:19 -0400 Subject: [PATCH 072/129] Add support for CodeIgniter 3.1.0 and PHP 7.2 --- README.md | 29 +- application/libraries/REST_Controller.php | 362 ++++++------------ .../libraries/REST_Controller_Definitions.php | 138 +++++++ composer.json | 4 +- 4 files changed, 271 insertions(+), 262 deletions(-) create mode 100644 application/libraries/REST_Controller_Definitions.php diff --git a/README.md b/README.md index d192d4ae..7f54e719 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,4 @@ + # CodeIgniter Rest Server [![Gitter chat](https://badges.gitter.im/chriskacerguis/codeigniter-restserver.png)](https://gitter.im/codeigniter-restserver/Lobby) @@ -7,8 +8,8 @@ config file and one controller. ## Requirements -1. PHP 5.4 or greater -2. CodeIgniter 3.0+ +1. PHP 7.2 or greater +2. CodeIgniter 3.1.10+ _Note: for 1.7.x support download v2.2 from Downloads tab_ @@ -39,8 +40,11 @@ When your controller extends from `REST_Controller`, the method names will be ap This allows you to implement a RESTful interface easily: ```php -class Books extends REST_Controller +class Books extends CI_Controller { + use REST_Controller { + REST_Controller::__construct as private __resTraitConstruct; + } public function index_get() { // Display all books @@ -69,9 +73,9 @@ The HTTP spec for DELETE requests precludes the use of parameters. For delete r ```php public function index_delete($id) { - $this->response([ - 'returned from delete:' => $id, - ]); + $this->response([ + 'returned from delete:' => $id, + ]); } ``` @@ -146,6 +150,7 @@ If your application uses language files to support multiple locales, `REST_Contr public function __construct() { parent::__construct(); + $this->__resTraitConstruct(); if (is_array($this->response->lang)) { @@ -194,12 +199,12 @@ You'll need to create a new database table to store and access the keys. `REST_C ```sql CREATE TABLE `keys` ( - `id` INT(11) NOT NULL AUTO_INCREMENT, - `key` VARCHAR(40) NOT NULL, - `level` INT(2) NOT NULL, - `ignore_limits` TINYINT(1) NOT NULL DEFAULT '0', - `date_created` INT(11) NOT NULL, - PRIMARY KEY (`id`) + `id` INT(11) NOT NULL AUTO_INCREMENT, + `key` VARCHAR(40) NOT NULL, + `level` INT(2) NOT NULL, + `ignore_limits` TINYINT(1) NOT NULL DEFAULT '0', + `date_created` INT(11) NOT NULL, + PRIMARY KEY (`id`) ) ENGINE=InnoDB DEFAULT CHARSET=utf8; ``` diff --git a/application/libraries/REST_Controller.php b/application/libraries/REST_Controller.php index 2363cfc4..bcda5f63 100644 --- a/application/libraries/REST_Controller.php +++ b/application/libraries/REST_Controller.php @@ -1,7 +1,6 @@ 'OK', - self::HTTP_CREATED => 'CREATED', - self::HTTP_NO_CONTENT => 'NO CONTENT', - self::HTTP_NOT_MODIFIED => 'NOT MODIFIED', - self::HTTP_BAD_REQUEST => 'BAD REQUEST', - self::HTTP_UNAUTHORIZED => 'UNAUTHORIZED', - self::HTTP_FORBIDDEN => 'FORBIDDEN', - self::HTTP_NOT_FOUND => 'NOT FOUND', - self::HTTP_METHOD_NOT_ALLOWED => 'METHOD NOT ALLOWED', - self::HTTP_NOT_ACCEPTABLE => 'NOT ACCEPTABLE', - self::HTTP_CONFLICT => 'CONFLICT', - self::HTTP_INTERNAL_SERVER_ERROR => 'INTERNAL SERVER ERROR', - self::HTTP_NOT_IMPLEMENTED => 'NOT IMPLEMENTED' + REST_Controller_Definitions::HTTP_OK => 'OK', + REST_Controller_Definitions::HTTP_CREATED => 'CREATED', + REST_Controller_Definitions::HTTP_NO_CONTENT => 'NO CONTENT', + REST_Controller_Definitions::HTTP_NOT_MODIFIED => 'NOT MODIFIED', + REST_Controller_Definitions::HTTP_BAD_REQUEST => 'BAD REQUEST', + REST_Controller_Definitions::HTTP_UNAUTHORIZED => 'UNAUTHORIZED', + REST_Controller_Definitions::HTTP_FORBIDDEN => 'FORBIDDEN', + REST_Controller_Definitions::HTTP_NOT_FOUND => 'NOT FOUND', + REST_Controller_Definitions::HTTP_METHOD_NOT_ALLOWED => 'METHOD NOT ALLOWED', + REST_Controller_Definitions::HTTP_NOT_ACCEPTABLE => 'NOT ACCEPTABLE', + REST_Controller_Definitions::HTTP_CONFLICT => 'CONFLICT', + REST_Controller_Definitions::HTTP_INTERNAL_SERVER_ERROR => 'INTERNAL SERVER ERROR', + REST_Controller_Definitions::HTTP_NOT_IMPLEMENTED => 'NOT IMPLEMENTED' ]; /** @@ -409,8 +275,8 @@ public function __construct($config = 'rest') if ($this->config->item('rest_enable_logging') === TRUE) { // Start the timer for how long the request takes - $this->_start_rtime = microtime(TRUE); - } + $this->_start_rtime = microtime(TRUE); + } // Load the rest.php configuration file $this->get_local_config($config); @@ -521,8 +387,8 @@ public function __construct($config = 'rest') if ($this->request->format && $this->request->body) { $this->request->body = Format::factory($this->request->body, $this->request->format)->to_array(); - - // Assign payload arguments to proper method container + + // Assign payload arguments to proper method container $this->{'_'.$this->request->method.'_args'} = $this->request->body; } @@ -574,7 +440,7 @@ public function __construct($config = 'rest') $this->response([ $this->config->item('rest_status_field_name') => FALSE, $this->config->item('rest_message_field_name') => $this->lang->line('text_rest_ajax_only') - ], self::HTTP_NOT_ACCEPTABLE); + ], REST_Controller_Definitions::HTTP_NOT_ACCEPTABLE); } // When there is no specific override for the current class/method, use the default auth value set in the config @@ -676,7 +542,7 @@ public function _remap($object_called, $arguments = []) $this->response([ $this->config->item('rest_status_field_name') => FALSE, $this->config->item('rest_message_field_name') => $this->lang->line('text_rest_unsupported') - ], self::HTTP_FORBIDDEN); + ], REST_Controller_Definitions::HTTP_FORBIDDEN); } // Remove the supported format from the function name e.g. index.json => index @@ -711,7 +577,7 @@ public function _remap($object_called, $arguments = []) $this->response([ $this->config->item('rest_status_field_name') => FALSE, $this->config->item('rest_message_field_name') => sprintf($this->lang->line('text_rest_invalid_api_key'), $this->rest->key) - ], self::HTTP_FORBIDDEN); + ], REST_Controller_Definitions::HTTP_FORBIDDEN); } // Check to see if this key has access to the requested controller @@ -725,7 +591,7 @@ public function _remap($object_called, $arguments = []) $this->response([ $this->config->item('rest_status_field_name') => FALSE, $this->config->item('rest_message_field_name') => $this->lang->line('text_rest_api_key_unauthorized') - ], self::HTTP_UNAUTHORIZED); + ], REST_Controller_Definitions::HTTP_UNAUTHORIZED); } // Sure it exists, but can they do anything with it? @@ -734,7 +600,7 @@ public function _remap($object_called, $arguments = []) $this->response([ $this->config->item('rest_status_field_name') => FALSE, $this->config->item('rest_message_field_name') => $this->lang->line('text_rest_unknown_method') - ], self::HTTP_METHOD_NOT_ALLOWED); + ], REST_Controller_Definitions::HTTP_METHOD_NOT_ALLOWED); } // Doing key related stuff? Can only do it if they have a key right? @@ -744,7 +610,7 @@ public function _remap($object_called, $arguments = []) if ($this->config->item('rest_enable_limits') && $this->_check_limit($controller_method) === FALSE) { $response = [$this->config->item('rest_status_field_name') => FALSE, $this->config->item('rest_message_field_name') => $this->lang->line('text_rest_api_key_time_limit')]; - $this->response($response, self::HTTP_UNAUTHORIZED); + $this->response($response, REST_Controller_Definitions::HTTP_UNAUTHORIZED); } // If no level is set use 0, they probably aren't using permissions @@ -761,7 +627,7 @@ public function _remap($object_called, $arguments = []) { // They don't have good enough perms $response = [$this->config->item('rest_status_field_name') => FALSE, $this->config->item('rest_message_field_name') => $this->lang->line('text_rest_api_key_permissions')]; - $this->response($response, self::HTTP_UNAUTHORIZED); + $this->response($response, REST_Controller_Definitions::HTTP_UNAUTHORIZED); } } @@ -769,7 +635,7 @@ public function _remap($object_called, $arguments = []) elseif ($this->config->item('rest_limits_method') == "IP_ADDRESS" && $this->config->item('rest_enable_limits') && $this->_check_limit($controller_method) === FALSE) { $response = [$this->config->item('rest_status_field_name') => FALSE, $this->config->item('rest_message_field_name') => $this->lang->line('text_rest_ip_address_time_limit')]; - $this->response($response, self::HTTP_UNAUTHORIZED); + $this->response($response, REST_Controller_Definitions::HTTP_UNAUTHORIZED); } // No key stuff, but record that stuff is happening @@ -809,87 +675,87 @@ public function _remap($object_called, $arguments = []) public function response($data = NULL, $http_code = NULL, $continue = FALSE) { //if profiling enabled then print profiling data - $isProfilingEnabled = $this->config->item('enable_profiling'); - if(!$isProfilingEnabled){ - ob_start(); - // If the HTTP status is not NULL, then cast as an integer - if ($http_code !== NULL) - { - // So as to be safe later on in the process - $http_code = (int) $http_code; - } - - // Set the output as NULL by default - $output = NULL; - - // If data is NULL and no HTTP status code provided, then display, error and exit - if ($data === NULL && $http_code === NULL) - { - $http_code = self::HTTP_NOT_FOUND; - } - - // If data is not NULL and a HTTP status code provided, then continue - elseif ($data !== NULL) - { - // If the format method exists, call and return the output in that format - if (method_exists(Format::class, 'to_' . $this->response->format)) - { - // Set the format header - $this->output->set_content_type($this->_supported_formats[$this->response->format], strtolower($this->config->item('charset'))); - $output = Format::factory($data)->{'to_' . $this->response->format}(); - - // An array must be parsed as a string, so as not to cause an array to string error - // Json is the most appropriate form for such a data type - if ($this->response->format === 'array') - { - $output = Format::factory($output)->{'to_json'}(); - } - } - else - { - // If an array or object, then parse as a json, so as to be a 'string' - if (is_array($data) || is_object($data)) - { - $data = Format::factory($data)->{'to_json'}(); - } - - // Format is not supported, so output the raw data as a string - $output = $data; - } - } - - // If not greater than zero, then set the HTTP status code as 200 by default - // Though perhaps 500 should be set instead, for the developer not passing a - // correct HTTP status code - $http_code > 0 || $http_code = self::HTTP_OK; - - $this->output->set_status_header($http_code); - - // JC: Log response code only if rest logging enabled - if ($this->config->item('rest_enable_logging') === TRUE) - { - $this->_log_response_code($http_code); - } - - // Output the data - $this->output->set_output($output); - - if ($continue === FALSE) - { - // Display the data and exit execution - $this->output->_display(); - exit; - } - else - { - ob_end_flush(); - } - - // Otherwise dump the output automatically - } - else{ - echo json_encode($data); - } + $isProfilingEnabled = $this->config->item('enable_profiling'); + if(!$isProfilingEnabled){ + ob_start(); + // If the HTTP status is not NULL, then cast as an integer + if ($http_code !== NULL) + { + // So as to be safe later on in the process + $http_code = (int) $http_code; + } + + // Set the output as NULL by default + $output = NULL; + + // If data is NULL and no HTTP status code provided, then display, error and exit + if ($data === NULL && $http_code === NULL) + { + $http_code = REST_Controller_Definitions::HTTP_NOT_FOUND; + } + + // If data is not NULL and a HTTP status code provided, then continue + elseif ($data !== NULL) + { + // If the format method exists, call and return the output in that format + if (method_exists(Format::class, 'to_' . $this->response->format)) + { + // Set the format header + $this->output->set_content_type($this->_supported_formats[$this->response->format], strtolower($this->config->item('charset'))); + $output = Format::factory($data)->{'to_' . $this->response->format}(); + + // An array must be parsed as a string, so as not to cause an array to string error + // Json is the most appropriate form for such a data type + if ($this->response->format === 'array') + { + $output = Format::factory($output)->{'to_json'}(); + } + } + else + { + // If an array or object, then parse as a json, so as to be a 'string' + if (is_array($data) || is_object($data)) + { + $data = Format::factory($data)->{'to_json'}(); + } + + // Format is not supported, so output the raw data as a string + $output = $data; + } + } + + // If not greater than zero, then set the HTTP status code as 200 by default + // Though perhaps 500 should be set instead, for the developer not passing a + // correct HTTP status code + $http_code > 0 || $http_code = REST_Controller_Definitions::HTTP_OK; + + $this->output->set_status_header($http_code); + + // JC: Log response code only if rest logging enabled + if ($this->config->item('rest_enable_logging') === TRUE) + { + $this->_log_response_code($http_code); + } + + // Output the data + $this->output->set_output($output); + + if ($continue === FALSE) + { + // Display the data and exit execution + $this->output->_display(); + exit; + } + else + { + ob_end_flush(); + } + + // Otherwise dump the output automatically + } + else{ + echo json_encode($data); + } } /** @@ -1104,7 +970,7 @@ protected function _detect_api_key() { // multiple ip addresses must be separated using a comma, explode and loop $list_ip_addresses = explode(',', $row->ip_addresses); - $ip_address = $this->input->ip_address(); + $ip_address = $this->input->ip_address(); $found_address = FALSE; foreach ($list_ip_addresses as $ip_address) @@ -2020,7 +1886,7 @@ protected function _check_php_session() $this->response([ $this->config->item('rest_status_field_name') => FALSE, $this->config->item('rest_message_field_name') => $this->lang->line('text_rest_unauthorized') - ], self::HTTP_UNAUTHORIZED); + ], REST_Controller_Definitions::HTTP_UNAUTHORIZED); } } @@ -2117,7 +1983,7 @@ protected function _prepare_digest_auth() $this->response([ $this->config->item('rest_status_field_name') => FALSE, $this->config->item('rest_message_field_name') => $this->lang->line('text_rest_invalid_credentials') - ], self::HTTP_UNAUTHORIZED); + ], REST_Controller_Definitions::HTTP_UNAUTHORIZED); } } @@ -2139,7 +2005,7 @@ protected function _check_blacklist_auth() $this->response([ $this->config->item('rest_status_field_name') => FALSE, $this->config->item('rest_message_field_name') => $this->lang->line('text_rest_ip_denied') - ], self::HTTP_UNAUTHORIZED); + ], REST_Controller_Definitions::HTTP_UNAUTHORIZED); } } @@ -2167,7 +2033,7 @@ protected function _check_whitelist_auth() $this->response([ $this->config->item('rest_status_field_name') => FALSE, $this->config->item('rest_message_field_name') => $this->lang->line('text_rest_ip_unauthorized') - ], self::HTTP_UNAUTHORIZED); + ], REST_Controller_Definitions::HTTP_UNAUTHORIZED); } } @@ -2205,7 +2071,7 @@ protected function _force_login($nonce = '') $this->response([ $this->config->item('rest_status_field_name') => FALSE, $this->config->item('rest_message_field_name') => $this->lang->line('text_rest_unauthorized') - ], self::HTTP_UNAUTHORIZED); + ], REST_Controller_Definitions::HTTP_UNAUTHORIZED); } /** @@ -2347,4 +2213,4 @@ protected function _check_cors() exit; } } -} +} \ No newline at end of file diff --git a/application/libraries/REST_Controller_Definitions.php b/application/libraries/REST_Controller_Definitions.php new file mode 100644 index 00000000..403842ad --- /dev/null +++ b/application/libraries/REST_Controller_Definitions.php @@ -0,0 +1,138 @@ +=5.4.0", - "codeigniter/framework": "^3.0.4" + "php": ">=7.1.0", + "codeigniter/framework": "^3.1.10" }, "autoload": { "classmap": [ From ae62b76bc6adc97cbed539eeb6df8ffc7e186fe5 Mon Sep 17 00:00:00 2001 From: azapater Date: Thu, 8 Aug 2019 16:47:12 +0100 Subject: [PATCH 073/129] private variable $auth_override made protected. This will avoid calling _auth_override_check() in case of need to check that info in the controller. --- application/libraries/REST_Controller.php | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/application/libraries/REST_Controller.php b/application/libraries/REST_Controller.php index bcda5f63..5df718ce 100644 --- a/application/libraries/REST_Controller.php +++ b/application/libraries/REST_Controller.php @@ -239,7 +239,7 @@ trait REST_Controller { /** * @var bool */ - private $auth_override; + protected $auth_override; /** * Extend this function to apply additional checking early on in the process @@ -387,7 +387,7 @@ public function __construct($config = 'rest') if ($this->request->format && $this->request->body) { $this->request->body = Format::factory($this->request->body, $this->request->format)->to_array(); - + // Assign payload arguments to proper method container $this->{'_'.$this->request->method.'_args'} = $this->request->body; } From 3ed956559303e4025371cfb70a10ff0d4d7a3561 Mon Sep 17 00:00:00 2001 From: Ray Li Date: Wed, 2 Oct 2019 01:11:24 -0500 Subject: [PATCH 074/129] QUICKFIX Continue Returns Response Fixes issue #1023 The added lines returns the response to the client and allows code to continue executing. `ob_end_flush; ` does not actually work correctly according to https://stackoverflow.com/questions/10579116/how-to-flush-data-to-browser-but-continue-executing It is kept for legacy compatibility and to prevent regressions. --- application/libraries/REST_Controller.php | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/application/libraries/REST_Controller.php b/application/libraries/REST_Controller.php index 5df718ce..ab836c3c 100644 --- a/application/libraries/REST_Controller.php +++ b/application/libraries/REST_Controller.php @@ -748,7 +748,19 @@ public function response($data = NULL, $http_code = NULL, $continue = FALSE) } else { - ob_end_flush(); + if (is_callable('fastcgi_finish_request')) + { + // Terminates connection and returns response to client on PHP-FPM. + $this->output->_display(); + ob_end_flush(); + fastcgi_finish_request(); + ignore_user_abort(true); + } + else + { + // Legacy compatibility. + ob_end_flush(); + } } // Otherwise dump the output automatically @@ -2213,4 +2225,4 @@ protected function _check_cors() exit; } } -} \ No newline at end of file +} From 67eaafb1cfb2ee0bb70034013b7359aaed11ac2f Mon Sep 17 00:00:00 2001 From: Salim Djerbouh Date: Thu, 3 Oct 2019 12:26:39 +0100 Subject: [PATCH 075/129] add import to handling requests example --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 7f54e719..7121a5f5 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,8 @@ When your controller extends from `REST_Controller`, the method names will be ap This allows you to implement a RESTful interface easily: ```php +use Restserver\Libraries\REST_Controller; + class Books extends CI_Controller { use REST_Controller { From fd04c3b44b02e78e5b61f663f36bb7a56e4f4ce2 Mon Sep 17 00:00:00 2001 From: Chris Kacerguis Date: Sun, 10 Nov 2019 13:56:25 -0600 Subject: [PATCH 076/129] latest changes for 3.1 --- .codeclimate.yml | 3 - AUTHORS.md | 10 - CHANGELOG.md | 66 - README.md | 271 +- application/config/config.php.sample | 482 -- application/config/hooks.php | 21 - application/config/ldap.php | 15 - application/config/profiler.php | 26 - application/config/routes.php | 62 - application/controllers/Rest_server.php | 13 - application/controllers/Welcome.php | 27 - application/controllers/api/Example.php | 140 - application/controllers/api/Key.php | 274 -- application/helpers/db_helper.php | 69 - application/hooks/hooks.profiler.php | 18 - .../language/dutch/rest_controller_lang.php | 16 - application/language/spanish/index.html | 11 - .../language/traditional-chinese/index.html | 11 - application/language/turkish/index.html | 11 - .../libraries/REST_Controller_Definitions.php | 138 - application/libraries/index.html | 11 - .../20170706025420_create_table_users.php | 69 - .../20170706030520_create_table_api_keys.php | 70 - .../20170706031435_create_table_api_logs.php | 76 - ...20170706032133_create_table_api_access.php | 63 - ...20170706032825_create_table_api_limits.php | 58 - application/migrations/index.html | 11 - application/views/index.html | 11 - application/views/rest_server.php | 222 - application/views/welcome_message.php | 101 - composer.json | 42 +- documentation/404.html | 110 - documentation/class-Example.html | 457 -- documentation/class-Format.html | 983 ---- documentation/class-Key.html | 512 --- documentation/class-REST_Controller.html | 3956 ----------------- documentation/class-Rest_server.html | 190 - documentation/class-Welcome.html | 203 - documentation/elementlist.js | 3 - documentation/index.html | 131 - .../package-CodeIgniter.Libraries.html | 117 - documentation/package-CodeIgniter.Rest.html | 123 - documentation/package-CodeIgniter.html | 113 - documentation/package-None.html | 127 - documentation/resources/collapsed.png | Bin 238 -> 0 bytes documentation/resources/combined.js | 1315 ------ documentation/resources/footer.png | Bin 7948 -> 0 bytes documentation/resources/inherit.png | Bin 152 -> 0 bytes documentation/resources/resize.png | Bin 216 -> 0 bytes documentation/resources/sort.png | Bin 171 -> 0 bytes documentation/resources/style.css | 614 --- documentation/resources/tree-cleaner.png | Bin 126 -> 0 bytes documentation/resources/tree-hasnext.png | Bin 128 -> 0 bytes documentation/resources/tree-last.png | Bin 172 -> 0 bytes documentation/resources/tree-vertical.png | Bin 127 -> 0 bytes documentation/source-class-Example.html | 242 - documentation/source-class-Format.html | 636 --- documentation/source-class-Key.html | 377 -- .../source-class-REST_Controller.html | 2316 ---------- documentation/source-class-Rest_server.html | 118 - documentation/source-class-Welcome.html | 132 - .../config => language/bulgarian}/index.html | 0 .../bulgarian/rest_controller_lang.php | 0 .../api => language/dutch}/index.html | 0 language/dutch/rest_controller_lang.php | 16 + .../english}/index.html | 0 .../english/rest_controller_lang.php | 0 .../helpers => language/french}/index.html | 0 .../french/rest_controller_lang.php | 2 +- .../bulgarian => language/german}/index.html | 0 .../german/rest_controller_lang.php | 2 +- .../greek/rest_controller_lang.php | 2 +- .../language/dutch => language}/index.html | 0 .../english => language/indonesia}/index.html | 0 .../indonesia/rest_controller_lang.php | 0 .../french => language/italian}/index.html | 0 .../italian/rest_controller_lang.php | 0 .../german => language/korean}/index.html | 0 .../korean/rest_controller_lang.php | 2 +- .../portuguese-brazilian}/index.html | 0 .../rest_controller_lang.php | 0 .../romanian}/index.html | 0 .../romanian/rest_controller_lang.php | 2 +- .../serbian_cyr}/index.html | 0 .../serbian_cyr/rest_controller_lang.php | 2 +- .../serbian_lat}/index.html | 0 .../serbian_lat/rest_controller_lang.php | 0 .../simplified-chinese/index.html | 0 .../rest_controller_lang.php | 2 +- .../spanish}/index.html | 0 .../spanish/rest_controller_lang.php | 2 +- .../traditional-chinese}/index.html | 0 .../rest_controller_lang.php | 0 .../turkish}/index.html | 0 .../turkish/rest_controller_lang.php | 0 {application/libraries => src}/Format.php | 268 +- .../RestController.php | 1318 +++--- src/auth/apikey.php | 0 src/auth/basic.php | 0 src/auth/ldap.php | 0 .../language/serbian_lat => src}/index.html | 0 {application/config => src}/rest.php | 11 +- 102 files changed, 768 insertions(+), 16054 deletions(-) delete mode 100644 .codeclimate.yml delete mode 100644 AUTHORS.md delete mode 100644 CHANGELOG.md delete mode 100644 application/config/config.php.sample delete mode 100644 application/config/hooks.php delete mode 100644 application/config/ldap.php delete mode 100644 application/config/profiler.php delete mode 100644 application/config/routes.php delete mode 100644 application/controllers/Rest_server.php delete mode 100644 application/controllers/Welcome.php delete mode 100644 application/controllers/api/Example.php delete mode 100644 application/controllers/api/Key.php delete mode 100755 application/helpers/db_helper.php delete mode 100644 application/hooks/hooks.profiler.php delete mode 100644 application/language/dutch/rest_controller_lang.php delete mode 100644 application/language/spanish/index.html delete mode 100644 application/language/traditional-chinese/index.html delete mode 100644 application/language/turkish/index.html delete mode 100644 application/libraries/REST_Controller_Definitions.php delete mode 100755 application/libraries/index.html delete mode 100644 application/migrations/20170706025420_create_table_users.php delete mode 100644 application/migrations/20170706030520_create_table_api_keys.php delete mode 100644 application/migrations/20170706031435_create_table_api_logs.php delete mode 100644 application/migrations/20170706032133_create_table_api_access.php delete mode 100644 application/migrations/20170706032825_create_table_api_limits.php delete mode 100644 application/migrations/index.html delete mode 100644 application/views/index.html delete mode 100644 application/views/rest_server.php delete mode 100644 application/views/welcome_message.php delete mode 100644 documentation/404.html delete mode 100644 documentation/class-Example.html delete mode 100644 documentation/class-Format.html delete mode 100644 documentation/class-Key.html delete mode 100644 documentation/class-REST_Controller.html delete mode 100644 documentation/class-Rest_server.html delete mode 100644 documentation/class-Welcome.html delete mode 100644 documentation/elementlist.js delete mode 100644 documentation/index.html delete mode 100644 documentation/package-CodeIgniter.Libraries.html delete mode 100644 documentation/package-CodeIgniter.Rest.html delete mode 100644 documentation/package-CodeIgniter.html delete mode 100644 documentation/package-None.html delete mode 100644 documentation/resources/collapsed.png delete mode 100644 documentation/resources/combined.js delete mode 100644 documentation/resources/footer.png delete mode 100644 documentation/resources/inherit.png delete mode 100644 documentation/resources/resize.png delete mode 100644 documentation/resources/sort.png delete mode 100644 documentation/resources/style.css delete mode 100644 documentation/resources/tree-cleaner.png delete mode 100644 documentation/resources/tree-hasnext.png delete mode 100644 documentation/resources/tree-last.png delete mode 100644 documentation/resources/tree-vertical.png delete mode 100644 documentation/source-class-Example.html delete mode 100644 documentation/source-class-Format.html delete mode 100644 documentation/source-class-Key.html delete mode 100644 documentation/source-class-REST_Controller.html delete mode 100644 documentation/source-class-Rest_server.html delete mode 100644 documentation/source-class-Welcome.html rename {application/config => language/bulgarian}/index.html (100%) rename {application/language => language}/bulgarian/rest_controller_lang.php (100%) rename {application/controllers/api => language/dutch}/index.html (100%) create mode 100644 language/dutch/rest_controller_lang.php rename {application/controllers => language/english}/index.html (100%) rename {application/language => language}/english/rest_controller_lang.php (100%) rename {application/helpers => language/french}/index.html (100%) rename {application/language => language}/french/rest_controller_lang.php (94%) rename {application/language/bulgarian => language/german}/index.html (100%) rename {application/language => language}/german/rest_controller_lang.php (94%) rename {application/language => language}/greek/rest_controller_lang.php (95%) rename {application/language/dutch => language}/index.html (100%) rename {application/language/english => language/indonesia}/index.html (100%) rename {application/language => language}/indonesia/rest_controller_lang.php (100%) rename {application/language/french => language/italian}/index.html (100%) rename {application/language => language}/italian/rest_controller_lang.php (100%) rename {application/language/german => language/korean}/index.html (100%) rename {application/language => language}/korean/rest_controller_lang.php (98%) rename {application/language => language/portuguese-brazilian}/index.html (100%) rename {application/language => language}/portuguese-brazilian/rest_controller_lang.php (100%) rename {application/language/indonesia => language/romanian}/index.html (100%) rename {application/language => language}/romanian/rest_controller_lang.php (93%) rename {application/language/italian => language/serbian_cyr}/index.html (100%) rename {application/language => language}/serbian_cyr/rest_controller_lang.php (96%) rename {application/language/korean => language/serbian_lat}/index.html (100%) rename {application/language => language}/serbian_lat/rest_controller_lang.php (100%) rename {application/language => language}/simplified-chinese/index.html (100%) rename {application/language => language}/simplified-chinese/rest_controller_lang.php (93%) rename {application/language/portuguese-brazilian => language/spanish}/index.html (100%) rename {application/language => language}/spanish/rest_controller_lang.php (92%) rename {application/language/romanian => language/traditional-chinese}/index.html (100%) rename {application/language => language}/traditional-chinese/rest_controller_lang.php (100%) rename {application/language/serbian_cyr => language/turkish}/index.html (100%) rename {application/language => language}/turkish/rest_controller_lang.php (100%) rename {application/libraries => src}/Format.php (68%) rename application/libraries/REST_Controller.php => src/RestController.php (63%) create mode 100644 src/auth/apikey.php create mode 100644 src/auth/basic.php create mode 100644 src/auth/ldap.php rename {application/language/serbian_lat => src}/index.html (100%) mode change 100644 => 100755 rename {application/config => src}/rest.php (99%) diff --git a/.codeclimate.yml b/.codeclimate.yml deleted file mode 100644 index b1059fca..00000000 --- a/.codeclimate.yml +++ /dev/null @@ -1,3 +0,0 @@ -exclude_paths: -- "documentation/" -- "application/language/" \ No newline at end of file diff --git a/AUTHORS.md b/AUTHORS.md deleted file mode 100644 index ee3551f6..00000000 --- a/AUTHORS.md +++ /dev/null @@ -1,10 +0,0 @@ -# The Core Team - -* [Chris Kacerguis](//github.com/chriskacerguis) -* [Phil Sturgeon](//github.com/philsturgeon) - -### Special Thanks To - -* [Fabian Hanisch](//github.com/Hanisch-IT) - -*For a list of people who have contributed to the codebase, see [GitHub's list of contributors](https://github.com/chriskacerguis/codeigniter-restserver/graphs/contributors). Anyone who has contributed please do a PR and add to this file.* diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index ce83aeda..00000000 --- a/CHANGELOG.md +++ /dev/null @@ -1,66 +0,0 @@ -Changelog: -=========== - -### UNRELEASED -* Added support for CodeIgniter controller's index methods (index_GET, index_POST...) -* Added exceptions handling when the method could not be found - -### 2.7.2 - -* Added $this->query() in which query parameters can now be obtained regardless of whether a GET request is sent or not -* Added doc comments added to functions -* Added HTTP status constants e.g. REST_Controller::HTTP_OK -* Added new CSV formatting function -* Fixed numerous bug fixes -* Updated API calls limit can be based on API key, routed url or method name -* Updated documentation -* Updated examples (thanks @ivantcholakov and @lagaisse) -* Updated many functions by re-writing (thanks @softwarespot) -* Updated performance increase - -### 2.7.0 - -* Added Blacklist IP option -* Added controller based access controls -* Added support for OPTIONS, PATCH, and HEAD (from boh1996) -* Added logging of the time it takes for a request (rtime column in DB) -* Changed DB schemas to use InnoDB, not MyISAM -* Updated Readme to reflect new developer (Chris Kacerguis) - -### 2.6.2 - -* Update CodeIgniter files to 2.1.3 -* Fixed issue #165 - -### 2.6.1 - -* Update CodeIgniter files to 2.1.2 -* Log Table support for IPv6 & NULL parameters -* Abstract out the processes of firing a controller method within _remap() to an separate method -* Moved GET, POST, PUT, and DELETE parsing to separate methods, allowing them to be overridden as needed -* Small bug-fix for a PHP 5.3 strlen error -* Fixed some PHP 5.4 warnings -* Fix for bug in Format.php's to_html() which failed to detect if $data was really a multidimensional array. -* Fix for empty node on XML output format, for false = 0, true = 1. - -### 2.6.0 - -* Added loads of PHPDoc comments. -* Response where method doesn't exist is now "HTTP 405 Method Not Allowed", not "HTTP 404 Not Found". -* Compatible with PHP 5.4. -* Added support for gzip compression. -* Fix the apache\_request\_header function with CGI. -* Fixed up correctly .foo extensions to work when get arguments provided. -* Allows method emulation via X-HTTP-Method-Override -* Support for Backbone.emulateHTTP improved. -* Combine both URI segment and GET params instead of using one or the other -* Separate each piece of the WWW-Authenticate header for digest requests with a comma. -* Added IP white-list option. - -### 2.5 - -* Instead of just seeing item, item, item, the singular version of the base-node will be used if possible. [Example](http://d.pr/RS46). -* Re-factored to use the Format library, which will soon be merged with CodeIgniter. -* Fixed Limit bug (limit of 5 would allow 6 requests). -* Added logging for invalid API key requests. -* Changed serialize to serialized. diff --git a/README.md b/README.md index 7121a5f5..4955bb84 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,26 @@ +# CodeIgniter RestServer -# CodeIgniter Rest Server +[![StyleCI](https://github.styleci.io/repos/219224674/shield?branch=master)](https://github.styleci.io/repos/219224674) -[![Gitter chat](https://badges.gitter.im/chriskacerguis/codeigniter-restserver.png)](https://gitter.im/codeigniter-restserver/Lobby) - -A fully RESTful server implementation for CodeIgniter using one library, one -config file and one controller. +A fully RESTful server implementation for CodeIgniter using one library, one config file and one controller. ## Requirements -1. PHP 7.2 or greater -2. CodeIgniter 3.1.10+ - -_Note: for 1.7.x support download v2.2 from Downloads tab_ - -## Important Update on 4.0.0 +- PHP 7.2 or greater +- CodeIgniter 3.1.11+ -Please note that version 4.0.0 is in the works, and is considered a breaking change (per SemVer). As CI 3.1.0 now has native support for Composer, this library will be moving to be composer based. +## Installation -Take a look at the "development" branch to see what's up. +```sh +composer require chriskacerguis/ci-restserver +``` -## Installation & loading +## Usage CodeIgniter Rest Server is available on [Packagist](https://packagist.org/packages/chriskacerguis/codeigniter-restserver) (using semantic versioning), and installation via composer is the recommended way to install Codeigniter Rest Server. Just add this line to your `composer.json` file: ```json -"chriskacerguis/codeigniter-restserver": "^3.0" +"chriskacerguis/codeigniter-restserver": "^3.1" ``` or run @@ -33,212 +29,63 @@ or run composer require chriskacerguis/codeigniter-restserver ``` -## Handling Requests - -When your controller extends from `REST_Controller`, the method names will be appended with the HTTP method used to access the request. If you're making an HTTP `GET` call to `/books`, for instance, it would call a `Books#index_get()` method. - -This allows you to implement a RESTful interface easily: - -```php -use Restserver\Libraries\REST_Controller; - -class Books extends CI_Controller -{ - use REST_Controller { - REST_Controller::__construct as private __resTraitConstruct; - } - public function index_get() - { - // Display all books - } - - public function index_post() - { - // Create a new book - } -} -``` - -`REST_Controller` also supports `PUT` and `DELETE` methods, allowing you to support a truly RESTful interface. - - -Accessing parameters is also easy. Simply use the name of the HTTP verb as a method: - -```php -$this->get('blah'); // GET param -$this->post('blah'); // POST param -$this->put('blah'); // PUT param -``` - -The HTTP spec for DELETE requests precludes the use of parameters. For delete requests, you can add items to the URL - -```php -public function index_delete($id) -{ - $this->response([ - 'returned from delete:' => $id, - ]); -} -``` - -If query parameters are passed via the URL, regardless of whether it's a GET request, can be obtained by the query method: - -```php -$this->query('blah'); // Query param -``` - -## Content Types - -`REST_Controller` supports a bunch of different request/response formats, including XML, JSON and serialised PHP. By default, the class will check the URL and look for a format either as an extension or as a separate segment. - -This means your URLs can look like this: -``` -http://example.com/books.json -http://example.com/books?format=json -``` - -This can be flaky with URI segments, so the recommend approach is using the HTTP `Accept` header: - -```bash -$ curl -H "Accept: application/json" http://example.com -``` - -Any responses you make from the class (see [responses](#responses) for more on this) will be serialised in the designated format. - -## Responses - -The class provides a `response()` method that allows you to return data in the user's requested response format. - -Returning any object / array / string / whatever is easy: - -```php -public function index_get() -{ - $this->response($this->db->get('books')->result()); -} -``` - -This will automatically return an `HTTP 200 OK` response. You can specify the status code in the second parameter: +Step 1: Add this to your controller (should be before any of your code) ```php -public function index_post() - { - // ...create new book - $this->response($book, 201); // Send an HTTP 201 Created - } +use chriskacerguis\RestServer\RestController; ``` -If you don't specify a response code, and the data you respond with `== FALSE` (an empty array or string, for instance), the response code will automatically be set to `404 Not Found`: +Step 2: Extend your controller ```php -$this->response([]); // HTTP 404 Not Found +class Example extends RestController ``` -## Configuration - -You can overwrite all default configurations by creating a rest.php file in your config folder with your configs. -All given configurations will overwrite the default ones. - -## Language - -You can overwrite all default language files. Just add a rest_controller_lang.php to your language and overwrite the what you want. - - -## Multilingual Support +## Basic GET example -If your application uses language files to support multiple locales, `REST_Controller` will automatically parse the HTTP `Accept-Language` header and provide the language(s) in your actions. This information can be found in the `$this->response->lang` object: +Here is a basic example of ```php -public function __construct() -{ - parent::__construct(); - $this->__resTraitConstruct(); - - if (is_array($this->response->lang)) - { - $this->load->language('application', $this->response->lang[0]); - } - else - { - $this->load->language('application', $this->response->lang); - } + 1, 'name' => 'John', 'email' => 'john@example.com'], + ['id' => 2, 'name' => 'Jim', 'email' => 'jim@example.com'], + ]; + + $id = $this->get('id'); + + if ($id === null) + { + // Check if the users data store contains users + if ($users) + { + // Set the response and exit + $this->response($users, 200); + } + else + { + // Set the response and exit + $this->response([ + 'status' => false, + 'message' => 'No users were found' + ], 404); + } + } + } } -``` - -## Authentication - -This class also provides rudimentary support for HTTP basic authentication and/or the securer HTTP digest access authentication. - -You can enable basic authentication by setting the `$config['rest_auth']` to `'basic'`. The `$config['rest_valid_logins']` directive can then be used to set the usernames and passwords able to log in to your system. The class will automatically send all the correct headers to trigger the authentication dialogue: - -```php -$config['rest_valid_logins'] = ['username' => 'password', 'other_person' => 'secure123']; -``` - -Enabling digest auth is similarly easy. Configure your desired logins in the config file like above, and set `$config['rest_auth']` to `'digest'`. The class will automatically send out the headers to enable digest auth. - -If you're tying this library into an AJAX endpoint where clients authenticate using PHP sessions then you may not like either of the digest nor basic authentication methods. In that case, you can tell the REST Library what PHP session variable to check for. If the variable exists, then the user is authorized. It will be up to your application to set that variable. You can define the variable in ``$config['auth_source']``. Then tell the library to use a php session variable by setting ``$config['rest_auth']`` to ``session``. - -All three methods of authentication can be secured further by using an IP white-list. If you enable `$config['rest_ip_whitelist_enabled']` in your config file, you can then set a list of allowed IPs. - -Any client connecting to your API will be checked against the white-listed IP array. If they're on the list, they'll be allowed access. If not, sorry, no can do hombre. The whitelist is a comma-separated string: - -```php -$config['rest_ip_whitelist'] = '123.456.789.0, 987.654.32.1'; -``` - -Your localhost IPs (`127.0.0.1` and `0.0.0.0`) are allowed by default. - -## API Keys - -In addition to the authentication methods above, the `REST_Controller` class also supports the use of API keys. Enabling API keys is easy. Turn it on in your **config/rest.php** file: - -```php -$config['rest_enable_keys'] = TRUE; -``` - -You'll need to create a new database table to store and access the keys. `REST_Controller` will automatically assume you have a table that looks like this: - -```sql -CREATE TABLE `keys` ( - `id` INT(11) NOT NULL AUTO_INCREMENT, - `key` VARCHAR(40) NOT NULL, - `level` INT(2) NOT NULL, - `ignore_limits` TINYINT(1) NOT NULL DEFAULT '0', - `date_created` INT(11) NOT NULL, - PRIMARY KEY (`id`) -) ENGINE=InnoDB DEFAULT CHARSET=utf8; -``` - -The class will look for an HTTP header with the API key on each request. An invalid or missing API key will result in an `HTTP 403 Forbidden`. - -By default, the HTTP will be `X-API-KEY`. This can be configured in **config/rest.php**. - -```bash -$ curl -X POST -H "X-API-KEY: some_key_here" http://example.com/books -``` -## Profiling -Codeigniter Profiler feature has been added to the library, so that you can use the power of CI profiler in your project just by setting config parameter to enable profile through out your application -Turn it on in your **config/config.php** file: - -```php -TRUE to turn profile ON, FALSE to turn it off -$config['enable_profiling'] = FALSE; -``` -Also you need to enable `hooks` in your config.php that looks like this -```php -$config['enable_hooks'] = TRUE; -``` -Also you can refer to **config/config.php.sample** - -## Other Documentation / Tutorials - -* [NetTuts: Working with RESTful Services in CodeIgniter](http://net.tutsplus.com/tutorials/php/working-with-restful-services-in-codeigniter-2/) - -## Contributions - -This project was originally written by Phil Sturgeon, however his involvement has shifted -as he is no longer using it. As of 2013/11/20 further development and support will be done by Chris Kacerguis. - -Pull Requests are the best way to fix bugs or add features. I know loads of you use this, so please -contribute if you have improvements to be made and I'll keep releasing versions over time. +``` \ No newline at end of file diff --git a/application/config/config.php.sample b/application/config/config.php.sample deleted file mode 100644 index 77411ce1..00000000 --- a/application/config/config.php.sample +++ /dev/null @@ -1,482 +0,0 @@ -]+$/i -| -| DO NOT CHANGE THIS UNLESS YOU FULLY UNDERSTAND THE REPERCUSSIONS!! -| -| Note: This option is ignored for CLI requests. -| -*/ -$config['permitted_uri_chars'] = 'a-z 0-9~%.:_\-'; - -/* -|-------------------------------------------------------------------------- -| Enable Query Strings -|-------------------------------------------------------------------------- -| -| By default CodeIgniter uses search-engine friendly segment based URLs: -| example.com/who/what/where/ -| -| You can optionally enable standard query string based URLs: -| example.com?who=me&what=something&where=here -| -| Options are: TRUE or FALSE (boolean) -| -| The other items let you set the query string 'words' that will -| invoke your controllers and its functions: -| example.com/index.php?c=controller&m=function -| -| Please note that some of the helpers won't work as expected when -| this feature is enabled, since CodeIgniter is designed primarily to -| use segment based URLs. -| -*/ -$config['enable_query_strings'] = FALSE; -$config['controller_trigger'] = 'c'; -$config['function_trigger'] = 'm'; -$config['directory_trigger'] = 'd'; - -/* -|-------------------------------------------------------------------------- -| Error Logging Threshold -|-------------------------------------------------------------------------- -| -| You can enable error logging by setting a threshold over zero. The -| threshold determines what gets logged. Threshold options are: -| -| 0 = Disables logging, Error logging TURNED OFF -| 1 = Error Messages (including PHP errors) -| 2 = Debug Messages -| 3 = Informational Messages -| 4 = All Messages -| -| You can also pass an array with threshold levels to show individual error types -| -| array(2) = Debug Messages, without Error Messages -| -| For a live site you'll usually only enable Errors (1) to be logged otherwise -| your log files will fill up very fast. -| -*/ -$config['log_threshold'] = 0; - -/* -|-------------------------------------------------------------------------- -| Error Logging Directory Path -|-------------------------------------------------------------------------- -| -| Leave this BLANK unless you would like to set something other than the default -| application/logs/ directory. Use a full server path. -| -*/ -$config['log_path'] = ''; - -/* -|-------------------------------------------------------------------------- -| Log File Extension -|-------------------------------------------------------------------------- -| -| The default filename extension for log files. The default 'php' allows for -| protecting the log files via basic scripting, when they are to be stored -| under a publicly accessible directory. -| -| Note: Leaving it blank will default to 'php'. -| -*/ -$config['log_file_extension'] = ''; - -/* -|-------------------------------------------------------------------------- -| Log File Permissions -|-------------------------------------------------------------------------- -| -| The file system permissions to be applied on newly created log files. -| -| IMPORTANT: This MUST be an integer (no quotes) and you MUST use octal -| integer notation (i.e. 0700, 0644, etc.) -*/ -$config['log_file_permissions'] = 0644; - -/* -|-------------------------------------------------------------------------- -| Date Format for Logs -|-------------------------------------------------------------------------- -| -| Each item that is logged has an associated date. You can use PHP date -| codes to set your own date formatting -| -*/ -$config['log_date_format'] = 'Y-m-d H:i:s'; - -/* -|-------------------------------------------------------------------------- -| Error Views Directory Path -|-------------------------------------------------------------------------- -| -| Leave this BLANK unless you would like to set something other than the default -| application/views/errors/ directory. Use a full server path. -| -*/ -$config['error_views_path'] = ''; - -/* -|-------------------------------------------------------------------------- -| Cache Directory Path -|-------------------------------------------------------------------------- -| -| Leave this BLANK unless you would like to set something other than the default -| application/cache/ directory. Use a full server path. -| -*/ -$config['cache_path'] = ''; - -/* -|-------------------------------------------------------------------------- -| Cache Include Query String -|-------------------------------------------------------------------------- -| -| Whether to take the URL query string into consideration when generating -| output cache files. Valid options are: -| -| FALSE = Disabled -| TRUE = Enabled, take all query parameters into account. -| Please be aware that this may result in numerous cache -| files generated for the same page over and over again. -| array('q') = Enabled, but only take into account the specified list -| of query parameters. -| -*/ -$config['cache_query_string'] = FALSE; - -/* -|-------------------------------------------------------------------------- -| Encryption Key -|-------------------------------------------------------------------------- -| -| If you use the Encryption class, you must set an encryption key. -| See the user guide for more info. -| -| https://codeigniter.com/user_guide/libraries/encryption.html -| -*/ -$config['encryption_key'] = ''; - -/* -|-------------------------------------------------------------------------- -| Session Variables -|-------------------------------------------------------------------------- -| -| 'sess_driver' -| -| The storage driver to use: files, database, redis, memcached -| -| 'sess_cookie_name' -| -| The session cookie name, must contain only [0-9a-z_-] characters -| -| 'sess_expiration' -| -| The number of SECONDS you want the session to last. -| Setting to 0 (zero) means expire when the browser is closed. -| -| 'sess_save_path' -| -| The location to save sessions to, driver dependent. -| -| For the 'files' driver, it's a path to a writable directory. -| WARNING: Only absolute paths are supported! -| -| For the 'database' driver, it's a table name. -| Please read up the manual for the format with other session drivers. -| -| IMPORTANT: You are REQUIRED to set a valid save path! -| -| 'sess_match_ip' -| -| Whether to match the user's IP address when reading the session data. -| -| WARNING: If you're using the database driver, don't forget to update -| your session table's PRIMARY KEY when changing this setting. -| -| 'sess_time_to_update' -| -| How many seconds between CI regenerating the session ID. -| -| 'sess_regenerate_destroy' -| -| Whether to destroy session data associated with the old session ID -| when auto-regenerating the session ID. When set to FALSE, the data -| will be later deleted by the garbage collector. -| -| Other session cookie settings are shared with the rest of the application, -| except for 'cookie_prefix' and 'cookie_httponly', which are ignored here. -| -*/ -$config['sess_driver'] = 'files'; -$config['sess_cookie_name'] = 'ci_session'; -$config['sess_expiration'] = 7200; -$config['sess_save_path'] = NULL; -$config['sess_match_ip'] = FALSE; -$config['sess_time_to_update'] = 300; -$config['sess_regenerate_destroy'] = FALSE; - -/* -|-------------------------------------------------------------------------- -| Cookie Related Variables -|-------------------------------------------------------------------------- -| -| 'cookie_prefix' = Set a cookie name prefix if you need to avoid collisions -| 'cookie_domain' = Set to .your-domain.com for site-wide cookies -| 'cookie_path' = Typically will be a forward slash -| 'cookie_secure' = Cookie will only be set if a secure HTTPS connection exists. -| 'cookie_httponly' = Cookie will only be accessible via HTTP(S) (no javascript) -| -| Note: These settings (with the exception of 'cookie_prefix' and -| 'cookie_httponly') will also affect sessions. -| -*/ -$config['cookie_prefix'] = ''; -$config['cookie_domain'] = ''; -$config['cookie_path'] = '/'; -$config['cookie_secure'] = FALSE; -$config['cookie_httponly'] = FALSE; - -/* -|-------------------------------------------------------------------------- -| Cross Site Request Forgery -|-------------------------------------------------------------------------- -| Enables a CSRF cookie token to be set. When set to TRUE, token will be -| checked on a submitted form. If you are accepting user data, it is strongly -| recommended CSRF protection be enabled. -| -| 'csrf_token_name' = The token name -| 'csrf_cookie_name' = The cookie name -| 'csrf_expire' = The number in seconds the token should expire. -| 'csrf_regenerate' = Regenerate token on every submission -| 'csrf_exclude_uris' = Array of URIs which ignore CSRF checks -*/ -$config['csrf_protection'] = FALSE; -$config['csrf_token_name'] = 'csrf_test_name'; -$config['csrf_cookie_name'] = 'csrf_cookie_name'; -$config['csrf_expire'] = 7200; -$config['csrf_regenerate'] = TRUE; -$config['csrf_exclude_uris'] = array(); - -/* -|-------------------------------------------------------------------------- -| Output Compression -|-------------------------------------------------------------------------- -| -| Enables Gzip output compression for faster page loads. When enabled, -| the output class will test whether your server supports Gzip. -| Even if it does, however, not all browsers support compression -| so enable only if you are reasonably sure your visitors can handle it. -| -| Only used if zlib.output_compression is turned off in your php.ini. -| Please do not use it together with httpd-level output compression. -| -| VERY IMPORTANT: If you are getting a blank page when compression is enabled it -| means you are prematurely outputting something to your browser. It could -| even be a line of whitespace at the end of one of your scripts. For -| compression to work, nothing can be sent before the output buffer is called -| by the output class. Do not 'echo' any values with compression enabled. -| -*/ -$config['compress_output'] = FALSE; - -/* -|-------------------------------------------------------------------------- -| Master Time Reference -|-------------------------------------------------------------------------- -| -| Options are 'local' or any PHP supported timezone. This preference tells -| the system whether to use your server's local time as the master 'now' -| reference, or convert it to the configured one timezone. See the 'date -| helper' page of the user guide for information regarding date handling. -| -*/ -$config['time_reference'] = 'local'; - -/* -|-------------------------------------------------------------------------- -| Reverse Proxy IPs -|-------------------------------------------------------------------------- -| -| If your server is behind a reverse proxy, you must whitelist the proxy -| IP addresses from which CodeIgniter should trust headers such as -| HTTP_X_FORWARDED_FOR and HTTP_CLIENT_IP in order to properly identify -| the visitor's IP address. -| -| You can use both an array or a comma-separated list of proxy addresses, -| as well as specifying whole subnets. Here are a few examples: -| -| Comma-separated: '10.0.1.200,192.168.5.0/24' -| Array: array('10.0.1.200', '192.168.5.0/24') -*/ -$config['proxy_ips'] = ''; diff --git a/application/config/hooks.php b/application/config/hooks.php deleted file mode 100644 index 7268904b..00000000 --- a/application/config/hooks.php +++ /dev/null @@ -1,21 +0,0 @@ - 'ProfilerEnabler', - 'function' => 'enableProfiler', - 'filename' => 'hooks.profiler.php', - 'filepath' => 'hooks', - 'params' => array() -); \ No newline at end of file diff --git a/application/config/ldap.php b/application/config/ldap.php deleted file mode 100644 index a54b985d..00000000 --- a/application/config/ldap.php +++ /dev/null @@ -1,15 +0,0 @@ - my_controller/index -| my-controller/my-method -> my_controller/my_method -*/ -$route['default_controller'] = 'welcome'; -$route['404_override'] = ''; -$route['translate_uri_dashes'] = true; - -/* -| ------------------------------------------------------------------------- -| Sample REST API Routes -| ------------------------------------------------------------------------- -*/ -$route['api/example/users/(:num)'] = 'api/example/users/id/$1'; // Example 4 -$route['api/example/users/(:num)(\.)([a-zA-Z0-9_-]+)(.*)'] = 'api/example/users/id/$1/format/$3$4'; // Example 8 diff --git a/application/controllers/Rest_server.php b/application/controllers/Rest_server.php deleted file mode 100644 index 5d44f921..00000000 --- a/application/controllers/Rest_server.php +++ /dev/null @@ -1,13 +0,0 @@ -load->helper('url'); - - $this->load->view('rest_server'); - } -} diff --git a/application/controllers/Welcome.php b/application/controllers/Welcome.php deleted file mode 100644 index 59818c7f..00000000 --- a/application/controllers/Welcome.php +++ /dev/null @@ -1,27 +0,0 @@ - - * @see https://codeigniter.com/user_guide/general/urls.html - */ - public function index() - { - $this->load->helper('url'); - - $this->load->view('welcome_message'); - } -} diff --git a/application/controllers/api/Example.php b/application/controllers/api/Example.php deleted file mode 100644 index 3b6de553..00000000 --- a/application/controllers/api/Example.php +++ /dev/null @@ -1,140 +0,0 @@ -methods['users_get']['limit'] = 500; // 500 requests per hour per user/key - $this->methods['users_post']['limit'] = 100; // 100 requests per hour per user/key - $this->methods['users_delete']['limit'] = 50; // 50 requests per hour per user/key - } - - public function users_get() - { - // Users from a data store e.g. database - $users = [ - ['id' => 1, 'name' => 'John', 'email' => 'john@example.com', 'fact' => 'Loves coding'], - ['id' => 2, 'name' => 'Jim', 'email' => 'jim@example.com', 'fact' => 'Developed on CodeIgniter'], - ['id' => 3, 'name' => 'Jane', 'email' => 'jane@example.com', 'fact' => 'Lives in the USA', ['hobbies' => ['guitar', 'cycling']]], - ]; - - $id = $this->get('id'); - - // If the id parameter doesn't exist return all the users - - if ($id === null) - { - // Check if the users data store contains users (in case the database result returns NULL) - if ($users) - { - // Set the response and exit - $this->response($users, REST_Controller::HTTP_OK); // OK (200) being the HTTP response code - } - else - { - // Set the response and exit - $this->response([ - 'status' => false, - 'message' => 'No users were found' - ], REST_Controller::HTTP_NOT_FOUND); // NOT_FOUND (404) being the HTTP response code - } - } - - // Find and return a single record for a particular user. - - $id = (int) $id; - - // Validate the id. - if ($id <= 0) - { - // Invalid id, set the response and exit. - $this->response(null, REST_Controller::HTTP_BAD_REQUEST); // BAD_REQUEST (400) being the HTTP response code - } - - // Get the user from the array, using the id as key for retrieval. - // Usually a model is to be used for this. - - $user = null; - - if (!empty($users)) - { - foreach ($users as $key => $value) - { - if (isset($value['id']) && $value['id'] === $id) - { - $user = $value; - } - } - } - - if (!empty($user)) - { - $this->set_response($user, REST_Controller::HTTP_OK); // OK (200) being the HTTP response code - } - else - { - $this->set_response([ - 'status' => false, - 'message' => 'User could not be found' - ], REST_Controller::HTTP_NOT_FOUND); // NOT_FOUND (404) being the HTTP response code - } - } - - public function users_post() - { - // $this->some_model->update_user( ... ); - $message = [ - 'id' => 100, // Automatically generated by the model - 'name' => $this->post('name'), - 'email' => $this->post('email'), - 'message' => 'Added a resource' - ]; - - $this->set_response($message, REST_Controller::HTTP_CREATED); // CREATED (201) being the HTTP response code - } - - public function users_delete() - { - $id = (int) $this->get('id'); - - // Validate the id. - if ($id <= 0) - { - // Set the response and exit - $this->response(null, REST_Controller::HTTP_BAD_REQUEST); // BAD_REQUEST (400) being the HTTP response code - } - - // $this->some_model->delete_something($id); - $message = [ - 'id' => $id, - 'message' => 'Deleted the resource' - ]; - - $this->set_response($message, REST_Controller::HTTP_NO_CONTENT); // NO_CONTENT (204) being the HTTP response code - } - -} diff --git a/application/controllers/api/Key.php b/application/controllers/api/Key.php deleted file mode 100644 index 585f9f60..00000000 --- a/application/controllers/api/Key.php +++ /dev/null @@ -1,274 +0,0 @@ - ['level' => 10, 'limit' => 10], - 'index_delete' => ['level' => 10], - 'level_post' => ['level' => 10], - 'regenerate_post' => ['level' => 10], - ]; - - /** - * Insert a key into the database - * - * @access public - * @return void - */ - public function index_put() - { - // Build a new key - $key = $this->_generate_key(); - - // If no key level provided, provide a generic key - $level = $this->put('level') ? $this->put('level') : 1; - $ignore_limits = ctype_digit($this->put('ignore_limits')) ? (int) $this->put('ignore_limits') : 1; - - // Insert the new key - if ($this->_insert_key($key, ['level' => $level, 'ignore_limits' => $ignore_limits])) - { - $this->response([ - 'status' => true, - 'key' => $key - ], REST_Controller::HTTP_CREATED); // CREATED (201) being the HTTP response code - } - else - { - $this->response([ - 'status' => false, - 'message' => 'Could not save the key' - ], REST_Controller::HTTP_INTERNAL_SERVER_ERROR); // INTERNAL_SERVER_ERROR (500) being the HTTP response code - } - } - - /** - * Remove a key from the database to stop it working - * - * @access public - * @return void - */ - public function index_delete() - { - $key = $this->delete('key'); - - // Does this key exist? - if (!$this->_key_exists($key)) - { - // It doesn't appear the key exists - $this->response([ - 'status' => false, - 'message' => 'Invalid API key' - ], REST_Controller::HTTP_BAD_REQUEST); // BAD_REQUEST (400) being the HTTP response code - } - - // Destroy it - $this->_delete_key($key); - - // Respond that the key was destroyed - $this->response([ - 'status' => true, - 'message' => 'API key was deleted' - ], REST_Controller::HTTP_NO_CONTENT); // NO_CONTENT (204) being the HTTP response code - } - - /** - * Change the level - * - * @access public - * @return void - */ - public function level_post() - { - $key = $this->post('key'); - $new_level = $this->post('level'); - - // Does this key exist? - if (!$this->_key_exists($key)) - { - // It doesn't appear the key exists - $this->response([ - 'status' => false, - 'message' => 'Invalid API key' - ], REST_Controller::HTTP_BAD_REQUEST); // BAD_REQUEST (400) being the HTTP response code - } - - // Update the key level - if ($this->_update_key($key, ['level' => $new_level])) - { - $this->response([ - 'status' => true, - 'message' => 'API key was updated' - ], REST_Controller::HTTP_OK); // OK (200) being the HTTP response code - } - else - { - $this->response([ - 'status' => false, - 'message' => 'Could not update the key level' - ], REST_Controller::HTTP_INTERNAL_SERVER_ERROR); // INTERNAL_SERVER_ERROR (500) being the HTTP response code - } - } - - /** - * Suspend a key - * - * @access public - * @return void - */ - public function suspend_post() - { - $key = $this->post('key'); - - // Does this key exist? - if (!$this->_key_exists($key)) - { - // It doesn't appear the key exists - $this->response([ - 'status' => false, - 'message' => 'Invalid API key' - ], REST_Controller::HTTP_BAD_REQUEST); // BAD_REQUEST (400) being the HTTP response code - } - - // Update the key level - if ($this->_update_key($key, ['level' => 0])) - { - $this->response([ - 'status' => true, - 'message' => 'Key was suspended' - ], REST_Controller::HTTP_OK); // OK (200) being the HTTP response code - } - else - { - $this->response([ - 'status' => false, - 'message' => 'Could not suspend the user' - ], REST_Controller::HTTP_INTERNAL_SERVER_ERROR); // INTERNAL_SERVER_ERROR (500) being the HTTP response code - } - } - - /** - * Regenerate a key - * - * @access public - * @return void - */ - public function regenerate_post() - { - $old_key = $this->post('key'); - $key_details = $this->_get_key($old_key); - - // Does this key exist? - if (!$key_details) - { - // It doesn't appear the key exists - $this->response([ - 'status' => false, - 'message' => 'Invalid API key' - ], REST_Controller::HTTP_BAD_REQUEST); // BAD_REQUEST (400) being the HTTP response code - } - - // Build a new key - $new_key = $this->_generate_key(); - - // Insert the new key - if ($this->_insert_key($new_key, ['level' => $key_details->level, 'ignore_limits' => $key_details->ignore_limits])) - { - // Suspend old key - $this->_update_key($old_key, ['level' => 0]); - - $this->response([ - 'status' => true, - 'key' => $new_key - ], REST_Controller::HTTP_CREATED); // CREATED (201) being the HTTP response code - } - else - { - $this->response([ - 'status' => false, - 'message' => 'Could not save the key' - ], REST_Controller::HTTP_INTERNAL_SERVER_ERROR); // INTERNAL_SERVER_ERROR (500) being the HTTP response code - } - } - - /* Helper Methods */ - - private function _generate_key() - { - do - { - // Generate a random salt - $salt = base_convert(bin2hex($this->security->get_random_bytes(64)), 16, 36); - - // If an error occurred, then fall back to the previous method - if ($salt === false) - { - $salt = hash('sha256', time() . mt_rand()); - } - - $new_key = substr($salt, 0, config_item('rest_key_length')); - } - while ($this->_key_exists($new_key)); - - return $new_key; - } - - /* Private Data Methods */ - - private function _get_key($key) - { - return $this->rest->db - ->where(config_item('rest_key_column'), $key) - ->get(config_item('rest_keys_table')) - ->row(); - } - - private function _key_exists($key) - { - return $this->rest->db - ->where(config_item('rest_key_column'), $key) - ->count_all_results(config_item('rest_keys_table')) > 0; - } - - private function _insert_key($key, $data) - { - $data[config_item('rest_key_column')] = $key; - $data['date_created'] = function_exists('now') ? now() : time(); - - return $this->rest->db - ->set($data) - ->insert(config_item('rest_keys_table')); - } - - private function _update_key($key, $data) - { - return $this->rest->db - ->where(config_item('rest_key_column'), $key) - ->update(config_item('rest_keys_table'), $data); - } - - private function _delete_key($key) - { - return $this->rest->db - ->where(config_item('rest_key_column'), $key) - ->delete(config_item('rest_keys_table')); - } - -} diff --git a/application/helpers/db_helper.php b/application/helpers/db_helper.php deleted file mode 100755 index 9a007a46..00000000 --- a/application/helpers/db_helper.php +++ /dev/null @@ -1,69 +0,0 @@ - - */ -defined('BASEPATH') OR exit('No direct script access allowed'); - -if ( ! function_exists('add_foreign_key')) -{ - /** - * @param string $table Table name - * @param string $foreign_key Collumn name having the Foreign Key - * @param string $references Table and column reference. Ex: users(id) - * @param string $on_delete RESTRICT, NO ACTION, CASCADE, SET NULL, SET DEFAULT - * @param string $on_update RESTRICT, NO ACTION, CASCADE, SET NULL, SET DEFAULT - * - * @return string SQL command - */ - function add_foreign_key($table, $foreign_key, $references, $on_delete = 'RESTRICT', $on_update = 'RESTRICT') - { - $references = explode('(', str_replace(')', '', str_replace('`', '', $references))); - - return "ALTER TABLE `{$table}` ADD CONSTRAINT `{$table}_{$foreign_key}_fk` FOREIGN KEY (`{$foreign_key}`) REFERENCES `{$references[0]}`(`{$references[1]}`) ON DELETE {$on_delete} ON UPDATE {$on_update}"; - } -} - -if ( ! function_exists('drop_foreign_key')) -{ - /** - * @param string $table Table name - * @param string $foreign_key Collumn name having the Foreign Key - * - * @return string SQL command - */ - function drop_foreign_key($table, $foreign_key) - { - return "ALTER TABLE `{$table}` DROP FOREIGN KEY `{$table}_{$foreign_key}_fk`"; - } -} - -if ( ! function_exists('add_trigger')) -{ - /** - * @param string $trigger_name Trigger name - * @param string $table Table name - * @param string $statement Command to run - * @param string $time BEFORE or AFTER - * @param string $event INSERT, UPDATE or DELETE - * @param string $type FOR EACH ROW [FOLLOWS|PRECEDES] - * - * @return string SQL Command - */ - function add_trigger($trigger_name, $table, $statement, $time = 'BEFORE', $event = 'INSERT', $type = 'FOR EACH ROW') - { - return 'DELIMITER ;;' . PHP_EOL . "CREATE TRIGGER `{$trigger_name}` {$time} {$event} ON `{$table}` {$type}" . PHP_EOL . 'BEGIN' . PHP_EOL . $statement . PHP_EOL . 'END;' . PHP_EOL . 'DELIMITER ;;'; - } -} - -if ( ! function_exists('drop_trigger')) -{ - /** - * @param string $trigger_name Trigger name - * - * @return string SQL Command - */ - function drop_trigger($trigger_name) - { - return "DROP TRIGGER {$trigger_name};"; - } -} diff --git a/application/hooks/hooks.profiler.php b/application/hooks/hooks.profiler.php deleted file mode 100644 index c376fdb8..00000000 --- a/application/hooks/hooks.profiler.php +++ /dev/null @@ -1,18 +0,0 @@ -output->enable_profiler( config_item('enable_profiling') ); - } -} -?> diff --git a/application/language/dutch/rest_controller_lang.php b/application/language/dutch/rest_controller_lang.php deleted file mode 100644 index 182ca61c..00000000 --- a/application/language/dutch/rest_controller_lang.php +++ /dev/null @@ -1,16 +0,0 @@ - - - - 403 Forbidden - - - -

Directory access is forbidden.

- - - diff --git a/application/language/traditional-chinese/index.html b/application/language/traditional-chinese/index.html deleted file mode 100644 index b702fbc3..00000000 --- a/application/language/traditional-chinese/index.html +++ /dev/null @@ -1,11 +0,0 @@ - - - - 403 Forbidden - - - -

Directory access is forbidden.

- - - diff --git a/application/language/turkish/index.html b/application/language/turkish/index.html deleted file mode 100644 index b702fbc3..00000000 --- a/application/language/turkish/index.html +++ /dev/null @@ -1,11 +0,0 @@ - - - - 403 Forbidden - - - -

Directory access is forbidden.

- - - diff --git a/application/libraries/REST_Controller_Definitions.php b/application/libraries/REST_Controller_Definitions.php deleted file mode 100644 index 403842ad..00000000 --- a/application/libraries/REST_Controller_Definitions.php +++ /dev/null @@ -1,138 +0,0 @@ - - - - 403 Forbidden - - - -

Directory access is forbidden.

- - - diff --git a/application/migrations/20170706025420_create_table_users.php b/application/migrations/20170706025420_create_table_users.php deleted file mode 100644 index 3553dad3..00000000 --- a/application/migrations/20170706025420_create_table_users.php +++ /dev/null @@ -1,69 +0,0 @@ - - */ -defined('BASEPATH') OR exit('No direct script access allowed'); - -/** - * Class Migration_create_table_users - * - * @property CI_DB_forge $dbforge - * @property CI_DB_query_builder $db - */ -class Migration_create_table_users extends CI_Migration { - - - protected $table = 'users'; - - - public function up() - { - $fields = array( - 'id' => [ - 'type' => 'INT(11)', - 'auto_increment' => true, - 'unsigned' => true, - ], - 'email' => [ - 'type' => 'VARCHAR(255)', - 'unique' => true, - ], - 'password' => [ - 'type' => 'VARCHAR(64)', - ], - 'firstname' => [ - 'type' => 'VARCHAR(32)', - ], - 'lastname' => [ - 'type' => 'VARCHAR(32)', - ], - 'created_at' => [ - 'type' => 'DATETIME', - ], - ); - $this->dbforge->add_field($fields); - $this->dbforge->add_key('id', true); - $this->dbforge->create_table($this->table, true); - - /*for ($i = 1; $i <= 100; $i++) - { - $this->db->insert($this->table, [ - 'email' => "user-{$i}@mail.com", - 'password' => password_hash('codeigniter', PASSWORD_DEFAULT), - 'firstname' => "Firstname {$i}", - 'lastname' => "Lastname {$i}", - 'created_at' => date('Y-' . rand(1, 12) . '-' . rand(1, 28) . ' H:i:s'), - ]); - }*/ - } - - - public function down() - { - if ($this->db->table_exists($this->table)) - { - $this->dbforge->drop_table($this->table); - } - } - -} diff --git a/application/migrations/20170706030520_create_table_api_keys.php b/application/migrations/20170706030520_create_table_api_keys.php deleted file mode 100644 index 42fb5417..00000000 --- a/application/migrations/20170706030520_create_table_api_keys.php +++ /dev/null @@ -1,70 +0,0 @@ - - */ -defined('BASEPATH') OR exit('No direct script access allowed'); - -/** - * Class Migration_create_table_api_keys - * - * @property CI_DB_forge $dbforge - * @property CI_DB_query_builder $db - */ -class Migration_create_table_api_keys extends CI_Migration { - - - public function up() - { - $this->config->load('rest'); - $table = config_item('rest_keys_table'); - $fields = array( - 'id' => [ - 'type' => 'INT(11)', - 'auto_increment' => true, - 'unsigned' => true, - ], - 'user_id' => [ - 'type' => 'INT(11)', - 'unsigned' => true, - ], - config_item('rest_key_column') => [ - 'type' => 'VARCHAR(' . config_item('rest_key_length') . ')', - 'unique' => true, - ], - 'level' => [ - 'type' => 'INT(2)', - ], - 'ignore_limits' => [ - 'type' => 'TINYINT(1)', - 'default' => 0, - ], - 'is_private_key' => [ - 'type' => 'TINYINT(1)', - 'default' => 0, - ], - 'ip_addresses' => [ - 'type' => 'TEXT', - 'null' => true, - ], - 'date_created' => [ - 'type' => 'INT(11)', - ], - ); - $this->dbforge->add_field($fields); - $this->dbforge->add_key('id', true); - $this->dbforge->create_table($table); - $this->db->query(add_foreign_key($table, 'user_id', 'users(id)', 'CASCADE', 'CASCADE')); - } - - - public function down() - { - $table = config_item('rest_key_column'); - if ($this->db->table_exists($table)) - { - $this->db->query(drop_foreign_key($table, 'user_id')); - $this->dbforge->drop_table($table); - } - } - -} diff --git a/application/migrations/20170706031435_create_table_api_logs.php b/application/migrations/20170706031435_create_table_api_logs.php deleted file mode 100644 index db8b4be4..00000000 --- a/application/migrations/20170706031435_create_table_api_logs.php +++ /dev/null @@ -1,76 +0,0 @@ - - */ -defined('BASEPATH') OR exit('No direct script access allowed'); - -/** - * Class Migration_create_table_api_logs - * - * @property CI_DB_forge $dbforge - * @property CI_DB_query_builder $db - */ -class Migration_create_table_api_logs extends CI_Migration { - - - public function up() - { - $this->config->load('rest'); - $table = config_item('rest_logs_table'); - $fields = array( - 'id' => [ - 'type' => 'INT(11)', - 'auto_increment' => true, - 'unsigned' => true, - ], - 'api_key' => [ - 'type' => 'VARCHAR(' . config_item('rest_key_length') . ')', - ], - 'uri' => [ - 'type' => 'VARCHAR(255)', - ], - 'method' => [ - 'type' => 'ENUM("get","post","options","put","patch","delete")', - ], - 'params' => [ - 'type' => 'TEXT', - 'null' => true, - ], - 'ip_address' => [ - 'type' => 'VARCHAR(45)', - ], - 'time' => [ - 'type' => 'INT(11)', - ], - 'rtime' => [ - 'type' => 'FLOAT', - 'null' => true, - ], - 'authorized' => [ - 'type' => 'VARCHAR(1)', - ], - 'response_code' => [ - 'type' => 'SMALLINT(3)', - 'null' => true, - 'default' => 0, - ], - ); - $this->dbforge->add_field($fields); - $this->dbforge->add_key('id', true); - $this->dbforge->create_table($table); - /*$this->db->query(add_foreign_key($table, 'api_key', - config_item('rest_keys_table') . '(' . config_item('rest_key_column') . ')', 'CASCADE', 'CASCADE'));*/ - } - - - public function down() - { - $table = config_item('rest_logs_table'); - if ($this->db->table_exists($table)) - { - // $this->db->query(drop_foreign_key($table, 'api_key')); - $this->dbforge->drop_table($table); - } - } - -} diff --git a/application/migrations/20170706032133_create_table_api_access.php b/application/migrations/20170706032133_create_table_api_access.php deleted file mode 100644 index df004dda..00000000 --- a/application/migrations/20170706032133_create_table_api_access.php +++ /dev/null @@ -1,63 +0,0 @@ - - */ -defined('BASEPATH') OR exit('No direct script access allowed'); - -/** - * Class Migration_create_table_api_access - * - * @property CI_DB_forge $dbforge - * @property CI_DB_query_builder $db - */ -class Migration_create_table_api_access extends CI_Migration { - - - public function up() - { - $this->config->load('rest'); - $table = config_item('rest_access_table'); - $fields = array( - 'id' => [ - 'type' => 'INT(11)', - 'auto_increment' => true, - 'unsigned' => true, - ], - 'key' => [ - 'type' => 'VARCHAR(' . config_item('rest_key_length') . ')', - ], - 'all_access' => [ - 'type' => 'TINYINT(1)', - 'default' => 0, - ], - 'controller' => [ - 'type' => 'VARCHAR(50)', - ], - 'date_created' => [ - 'type' => 'DATETIME', - 'null' => true, - ], - 'date_modified' => [ - 'type' => 'TIMESTAMP', - ], - ); - $this->dbforge->add_field($fields); - $this->dbforge->add_key('id', true); - $this->dbforge->add_key('controller'); - $this->dbforge->create_table($table); - $this->db->query(add_foreign_key($table, 'key', - config_item('rest_keys_table') . '(' . config_item('rest_key_column') . ')', 'CASCADE', 'CASCADE')); - } - - - public function down() - { - $table = config_item('rest_access_table'); - if ($this->db->table_exists($table)) - { - $this->db->query(drop_foreign_key($table, 'key')); - $this->dbforge->drop_table($table); - } - } - -} diff --git a/application/migrations/20170706032825_create_table_api_limits.php b/application/migrations/20170706032825_create_table_api_limits.php deleted file mode 100644 index c7355cb7..00000000 --- a/application/migrations/20170706032825_create_table_api_limits.php +++ /dev/null @@ -1,58 +0,0 @@ - - */ -defined('BASEPATH') OR exit('No direct script access allowed'); - -/** - * Class Migration_create_table_api_limits - * - * @property CI_DB_forge $dbforge - * @property CI_DB_query_builder $db - */ -class Migration_create_table_api_limits extends CI_Migration { - - - public function up() - { - $this->config->load('rest'); - $table = config_item('rest_limits_table'); - $fields = array( - 'id' => [ - 'type' => 'INT(11)', - 'auto_increment' => true, - 'unsigned' => true, - ], - 'api_key' => [ - 'type' => 'VARCHAR(' . config_item('rest_key_length') . ')', - ], - 'uri' => [ - 'type' => 'VARCHAR(255)', - ], - 'count' => [ - 'type' => 'INT(10)', - ], - 'hour_started' => [ - 'type' => 'INT(11)', - ], - ); - $this->dbforge->add_field($fields); - $this->dbforge->add_key('id', true); - $this->dbforge->add_key('uri'); - $this->dbforge->create_table($table); - $this->db->query(add_foreign_key($table, 'api_key', - config_item('rest_keys_table') . '(' . config_item('rest_key_column') . ')', 'CASCADE', 'CASCADE')); - } - - - public function down() - { - $table = config_item('rest_limits_table'); - if ($this->db->table_exists($table)) - { - $this->db->query(drop_foreign_key($table, 'api_key')); - $this->dbforge->drop_table($table); - } - } - -} diff --git a/application/migrations/index.html b/application/migrations/index.html deleted file mode 100644 index b702fbc3..00000000 --- a/application/migrations/index.html +++ /dev/null @@ -1,11 +0,0 @@ - - - - 403 Forbidden - - - -

Directory access is forbidden.

- - - diff --git a/application/views/index.html b/application/views/index.html deleted file mode 100644 index b702fbc3..00000000 --- a/application/views/index.html +++ /dev/null @@ -1,11 +0,0 @@ - - - - 403 Forbidden - - - -

Directory access is forbidden.

- - - diff --git a/application/views/rest_server.php b/application/views/rest_server.php deleted file mode 100644 index 5212e6da..00000000 --- a/application/views/rest_server.php +++ /dev/null @@ -1,222 +0,0 @@ - - - - - - - REST Server Tests - - - - - -
-

REST Server Tests

- -
- -

Home

- -

- See the article - - http://net.tutsplus.com/tutorials/php/working-with-restful-services-in-codeigniter-2/ - -

- -

- The master project repository is - - https://github.com/chriskacerguis/codeigniter-restserver - -

- -

- Click on the links to check whether the REST server is working. -

- -
    -
  1. Users - defaulting to JSON
    2. -
  2. Users - get it in CSV
    3. -
  3. User #1 - defaulting to JSON (users/id/1)
    4. -
  4. User #1 - defaulting to JSON (users/1)
    5. -
  5. User #1 - get it in XML (users/id/1.xml)
    6. -
  6. User #1 - get it in XML (users/id/1/format/xml)
    7. -
  7. User #1 - get it in XML (users/id/1?format=xml)
    8. -
  8. User #1 - get it in XML (users/1.xml)
    9. -
  9. Users - get it in JSON (AJAX request)
    10. -
  10. Users - get it in HTML (users.html)
    11. -
  11. Users - get it in HTML (users/format/html)
    12. -
  12. Users - get it in HTML (users?format=html)
    13. -
- -
- -

Page rendered in {elapsed_time} seconds. '.CI_VERSION.'' : '' ?>

-
- - - - - - - diff --git a/application/views/welcome_message.php b/application/views/welcome_message.php deleted file mode 100644 index 9ba456fc..00000000 --- a/application/views/welcome_message.php +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - - Welcome to CodeIgniter - - - - - -
-

Welcome to CodeIgniter!

- -
- -

REST Server Tests

- - -

REST Server Documentation

- - -

The page you are looking at is being generated dynamically by CodeIgniter.

- -

If you would like to edit this page you'll find it located at:

- application/views/welcome_message.php - -

The corresponding controller for this page is found at:

- application/controllers/Welcome.php - - -

If you are exploring CodeIgniter for the very first time, you should start by reading the User Guide.

- -
- -

Page rendered in {elapsed_time} seconds. '.CI_VERSION.'' : '' ?>

-
- - - diff --git a/composer.json b/composer.json index 979fd5a3..329d3b46 100644 --- a/composer.json +++ b/composer.json @@ -1,29 +1,17 @@ { - "description": "REST Server for the CodeIgniter framework", - "name": "chriskacerguis/codeigniter-restserver", - "type": "library", - "homepage": "https://github.com/chriskacerguis/codeigniter-restserver", - "authors": [ - { - "name": "Chris Kacerguis", - "role": "Developer" - } - ], - "license": "MIT", - "support": { - "source": "https://github.com/chriskacerguis/codeigniter-restserver" - }, - "require": { - "php": ">=7.1.0", - "codeigniter/framework": "^3.1.10" - }, - "autoload": { - "classmap": [ - "application/libraries/Format.php", - "application/libraries/REST_Controller.php" - ], - "psr-4" : { - "Restserver\\Libraries\\" : "application/libraries/" - } - } + "name": "chriskacerguis/codeigniter-restserver", + "description": "CI Rest Server", + "type": "library", + "license": "MIT", + "authors": [ + { + "name": "Chris Kacerguis", + "email": "chriskacerguis@gmail.com" + } + ], + "minimum-stability": "dev", + "autoload": { + "psr-4": {"chriskacerguis\\RestServer\\": "src/"} + }, + "require": {} } diff --git a/documentation/404.html b/documentation/404.html deleted file mode 100644 index 27b3bc36..00000000 --- a/documentation/404.html +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - - Page not found - - - - - - -
- -
- -
- - - - - - diff --git a/documentation/class-Example.html b/documentation/class-Example.html deleted file mode 100644 index 7959da84..00000000 --- a/documentation/class-Example.html +++ /dev/null @@ -1,457 +0,0 @@ - - - - - - Class Example - - - - - - -
- -
- -
- - - - - - diff --git a/documentation/class-Format.html b/documentation/class-Format.html deleted file mode 100644 index 07d2a5df..00000000 --- a/documentation/class-Format.html +++ /dev/null @@ -1,983 +0,0 @@ - - - - - - Class Format - - - - - - -
- -
- -
- - - - - - diff --git a/documentation/class-Key.html b/documentation/class-Key.html deleted file mode 100644 index d999bfa1..00000000 --- a/documentation/class-Key.html +++ /dev/null @@ -1,512 +0,0 @@ - - - - - - Class Key - - - - - - -
- -
- -
- - - - - - diff --git a/documentation/class-REST_Controller.html b/documentation/class-REST_Controller.html deleted file mode 100644 index 1537c7cc..00000000 --- a/documentation/class-REST_Controller.html +++ /dev/null @@ -1,3956 +0,0 @@ - - - - - - Class REST_Controller - - - - - - -
- -
- -
- - - - - - diff --git a/documentation/class-Rest_server.html b/documentation/class-Rest_server.html deleted file mode 100644 index 20eae472..00000000 --- a/documentation/class-Rest_server.html +++ /dev/null @@ -1,190 +0,0 @@ - - - - - - Class Rest_server - - - - - - -
- -
- -
- - - - - - diff --git a/documentation/class-Welcome.html b/documentation/class-Welcome.html deleted file mode 100644 index cb9f0f28..00000000 --- a/documentation/class-Welcome.html +++ /dev/null @@ -1,203 +0,0 @@ - - - - - - Class Welcome - - - - - - -
- -
- -
- - - - - - diff --git a/documentation/elementlist.js b/documentation/elementlist.js deleted file mode 100644 index b52ccbf6..00000000 --- a/documentation/elementlist.js +++ /dev/null @@ -1,3 +0,0 @@ - -var ApiGen = ApiGen || {}; -ApiGen.elements = [["c","Example"],["c","Format"],["c","Key"],["c","REST_Controller"],["c","Rest_server"],["c","Welcome"]]; diff --git a/documentation/index.html b/documentation/index.html deleted file mode 100644 index e2e1801a..00000000 --- a/documentation/index.html +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - Overview - - - - - - -
- -
- -
- - - - - - diff --git a/documentation/package-CodeIgniter.Libraries.html b/documentation/package-CodeIgniter.Libraries.html deleted file mode 100644 index 2e0fe2ed..00000000 --- a/documentation/package-CodeIgniter.Libraries.html +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - Package CodeIgniter\Libraries - - - - - - -
- -
- -
- - - - - - diff --git a/documentation/package-CodeIgniter.Rest.html b/documentation/package-CodeIgniter.Rest.html deleted file mode 100644 index f6d41a7d..00000000 --- a/documentation/package-CodeIgniter.Rest.html +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - Package CodeIgniter\Rest - - - - - - -
- -
- -
- - - - - - diff --git a/documentation/package-CodeIgniter.html b/documentation/package-CodeIgniter.html deleted file mode 100644 index e9351dfc..00000000 --- a/documentation/package-CodeIgniter.html +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - Package CodeIgniter - - - - - - -
- -
- -
- - - - - - diff --git a/documentation/package-None.html b/documentation/package-None.html deleted file mode 100644 index 08b3ad5c..00000000 --- a/documentation/package-None.html +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - No package - - - - - - -
- -
- -
- - - - - - diff --git a/documentation/resources/collapsed.png b/documentation/resources/collapsed.png deleted file mode 100644 index 56e7323931a3ca5774e2e85ba622c6282c122f5f..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 238 zcmeAS@N?(olHy`uVBq!ia0vp^5+KaM1|%Pp+x`Gjk|nMYCBgY=CFO}lsSJ)O`AMk? zp1FzXsX?iUDV2pMQ*D5XCV09yhE&{2`t$$4z4PH~`Tr$57mdKI;Vst0QmG<2><{9 diff --git a/documentation/resources/combined.js b/documentation/resources/combined.js deleted file mode 100644 index 84bde60a..00000000 --- a/documentation/resources/combined.js +++ /dev/null @@ -1,1315 +0,0 @@ - -var ApiGen = ApiGen || {}; -ApiGen.config = {"options":{"elementDetailsCollapsed":true,"elementsOrder":"natural"},"name":"ApiGen theme","templatesPath":"phar:\/\/C:\/Users\/softwarespot\/Documents\/GitHub\/codeigniter-restserver\/apigen.phar\/bin\/..\/\/vendor\/apigen\/theme-default\/src","resources":{"phar:\/\/C:\/Users\/softwarespot\/Documents\/GitHub\/codeigniter-restserver\/apigen.phar\/bin\/..\/\/vendor\/apigen\/theme-default\/src\/resources":"resources"},"templates":{"overview":{"filename":"index.html","template":"phar:\/\/C:\/Users\/softwarespot\/Documents\/GitHub\/codeigniter-restserver\/apigen.phar\/bin\/..\/\/vendor\/apigen\/theme-default\/src\/overview.latte"},"combined":{"filename":"resources\/combined.js","template":"phar:\/\/C:\/Users\/softwarespot\/Documents\/GitHub\/codeigniter-restserver\/apigen.phar\/bin\/..\/\/vendor\/apigen\/theme-default\/src\/combined.js.latte"},"elementlist":{"filename":"elementlist.js","template":"phar:\/\/C:\/Users\/softwarespot\/Documents\/GitHub\/codeigniter-restserver\/apigen.phar\/bin\/..\/\/vendor\/apigen\/theme-default\/src\/elementlist.js.latte"},"404":{"filename":"404.html","template":"phar:\/\/C:\/Users\/softwarespot\/Documents\/GitHub\/codeigniter-restserver\/apigen.phar\/bin\/..\/\/vendor\/apigen\/theme-default\/src\/404.latte"},"package":{"filename":"package-%s.html","template":"phar:\/\/C:\/Users\/softwarespot\/Documents\/GitHub\/codeigniter-restserver\/apigen.phar\/bin\/..\/\/vendor\/apigen\/theme-default\/src\/package.latte"},"namespace":{"filename":"namespace-%s.html","template":"phar:\/\/C:\/Users\/softwarespot\/Documents\/GitHub\/codeigniter-restserver\/apigen.phar\/bin\/..\/\/vendor\/apigen\/theme-default\/src\/namespace.latte"},"class":{"filename":"class-%s.html","template":"phar:\/\/C:\/Users\/softwarespot\/Documents\/GitHub\/codeigniter-restserver\/apigen.phar\/bin\/..\/\/vendor\/apigen\/theme-default\/src\/class.latte"},"constant":{"filename":"constant-%s.html","template":"phar:\/\/C:\/Users\/softwarespot\/Documents\/GitHub\/codeigniter-restserver\/apigen.phar\/bin\/..\/\/vendor\/apigen\/theme-default\/src\/constant.latte"},"function":{"filename":"function-%s.html","template":"phar:\/\/C:\/Users\/softwarespot\/Documents\/GitHub\/codeigniter-restserver\/apigen.phar\/bin\/..\/\/vendor\/apigen\/theme-default\/src\/function.latte"},"annotationGroup":{"filename":"annotation-group-%s.html","template":"phar:\/\/C:\/Users\/softwarespot\/Documents\/GitHub\/codeigniter-restserver\/apigen.phar\/bin\/..\/\/vendor\/apigen\/theme-default\/src\/annotation-group.latte"},"source":{"filename":"source-%s.html","template":"phar:\/\/C:\/Users\/softwarespot\/Documents\/GitHub\/codeigniter-restserver\/apigen.phar\/bin\/..\/\/vendor\/apigen\/theme-default\/src\/source.latte"},"tree":{"filename":"tree.html","template":"phar:\/\/C:\/Users\/softwarespot\/Documents\/GitHub\/codeigniter-restserver\/apigen.phar\/bin\/..\/\/vendor\/apigen\/theme-default\/src\/tree.latte"},"sitemap":{"filename":"sitemap.xml","template":"phar:\/\/C:\/Users\/softwarespot\/Documents\/GitHub\/codeigniter-restserver\/apigen.phar\/bin\/..\/\/vendor\/apigen\/theme-default\/src\/sitemap.xml.latte"},"opensearch":{"filename":"opensearch.xml","template":"phar:\/\/C:\/Users\/softwarespot\/Documents\/GitHub\/codeigniter-restserver\/apigen.phar\/bin\/..\/\/vendor\/apigen\/theme-default\/src\/opensearch.xml.latte"},"robots":{"filename":"robots.txt","template":"phar:\/\/C:\/Users\/softwarespot\/Documents\/GitHub\/codeigniter-restserver\/apigen.phar\/bin\/..\/\/vendor\/apigen\/theme-default\/src\/robots.txt.latte"}}}; - - - /*! jQuery v1.10.2 | (c) 2005, 2013 jQuery Foundation, Inc. | jquery.org/license -*/ -(function(e,t){var n,r,i=typeof t,o=e.location,a=e.document,s=a.documentElement,l=e.jQuery,u=e.$,c={},p=[],f="1.10.2",d=p.concat,h=p.push,g=p.slice,m=p.indexOf,y=c.toString,v=c.hasOwnProperty,b=f.trim,x=function(e,t){return new x.fn.init(e,t,r)},w=/[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/.source,T=/\S+/g,C=/^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g,N=/^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]*))$/,k=/^<(\w+)\s*\/?>(?:<\/\1>|)$/,E=/^[\],:{}\s]*$/,S=/(?:^|:|,)(?:\s*\[)+/g,A=/\\(?:["\\\/bfnrt]|u[\da-fA-F]{4})/g,j=/"[^"\\\r\n]*"|true|false|null|-?(?:\d+\.|)\d+(?:[eE][+-]?\d+|)/g,D=/^-ms-/,L=/-([\da-z])/gi,H=function(e,t){return t.toUpperCase()},q=function(e){(a.addEventListener||"load"===e.type||"complete"===a.readyState)&&(_(),x.ready())},_=function(){a.addEventListener?(a.removeEventListener("DOMContentLoaded",q,!1),e.removeEventListener("load",q,!1)):(a.detachEvent("onreadystatechange",q),e.detachEvent("onload",q))};x.fn=x.prototype={jquery:f,constructor:x,init:function(e,n,r){var i,o;if(!e)return this;if("string"==typeof e){if(i="<"===e.charAt(0)&&">"===e.charAt(e.length-1)&&e.length>=3?[null,e,null]:N.exec(e),!i||!i[1]&&n)return!n||n.jquery?(n||r).find(e):this.constructor(n).find(e);if(i[1]){if(n=n instanceof x?n[0]:n,x.merge(this,x.parseHTML(i[1],n&&n.nodeType?n.ownerDocument||n:a,!0)),k.test(i[1])&&x.isPlainObject(n))for(i in n)x.isFunction(this[i])?this[i](n[i]):this.attr(i,n[i]);return this}if(o=a.getElementById(i[2]),o&&o.parentNode){if(o.id!==i[2])return r.find(e);this.length=1,this[0]=o}return this.context=a,this.selector=e,this}return e.nodeType?(this.context=this[0]=e,this.length=1,this):x.isFunction(e)?r.ready(e):(e.selector!==t&&(this.selector=e.selector,this.context=e.context),x.makeArray(e,this))},selector:"",length:0,toArray:function(){return g.call(this)},get:function(e){return null==e?this.toArray():0>e?this[this.length+e]:this[e]},pushStack:function(e){var t=x.merge(this.constructor(),e);return t.prevObject=this,t.context=this.context,t},each:function(e,t){return x.each(this,e,t)},ready:function(e){return x.ready.promise().done(e),this},slice:function(){return this.pushStack(g.apply(this,arguments))},first:function(){return this.eq(0)},last:function(){return this.eq(-1)},eq:function(e){var t=this.length,n=+e+(0>e?t:0);return this.pushStack(n>=0&&t>n?[this[n]]:[])},map:function(e){return this.pushStack(x.map(this,function(t,n){return e.call(t,n,t)}))},end:function(){return this.prevObject||this.constructor(null)},push:h,sort:[].sort,splice:[].splice},x.fn.init.prototype=x.fn,x.extend=x.fn.extend=function(){var e,n,r,i,o,a,s=arguments[0]||{},l=1,u=arguments.length,c=!1;for("boolean"==typeof s&&(c=s,s=arguments[1]||{},l=2),"object"==typeof s||x.isFunction(s)||(s={}),u===l&&(s=this,--l);u>l;l++)if(null!=(o=arguments[l]))for(i in o)e=s[i],r=o[i],s!==r&&(c&&r&&(x.isPlainObject(r)||(n=x.isArray(r)))?(n?(n=!1,a=e&&x.isArray(e)?e:[]):a=e&&x.isPlainObject(e)?e:{},s[i]=x.extend(c,a,r)):r!==t&&(s[i]=r));return s},x.extend({expando:"jQuery"+(f+Math.random()).replace(/\D/g,""),noConflict:function(t){return e.$===x&&(e.$=u),t&&e.jQuery===x&&(e.jQuery=l),x},isReady:!1,readyWait:1,holdReady:function(e){e?x.readyWait++:x.ready(!0)},ready:function(e){if(e===!0?!--x.readyWait:!x.isReady){if(!a.body)return setTimeout(x.ready);x.isReady=!0,e!==!0&&--x.readyWait>0||(n.resolveWith(a,[x]),x.fn.trigger&&x(a).trigger("ready").off("ready"))}},isFunction:function(e){return"function"===x.type(e)},isArray:Array.isArray||function(e){return"array"===x.type(e)},isWindow:function(e){return null!=e&&e==e.window},isNumeric:function(e){return!isNaN(parseFloat(e))&&isFinite(e)},type:function(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?c[y.call(e)]||"object":typeof e},isPlainObject:function(e){var n;if(!e||"object"!==x.type(e)||e.nodeType||x.isWindow(e))return!1;try{if(e.constructor&&!v.call(e,"constructor")&&!v.call(e.constructor.prototype,"isPrototypeOf"))return!1}catch(r){return!1}if(x.support.ownLast)for(n in e)return v.call(e,n);for(n in e);return n===t||v.call(e,n)},isEmptyObject:function(e){var t;for(t in e)return!1;return!0},error:function(e){throw Error(e)},parseHTML:function(e,t,n){if(!e||"string"!=typeof e)return null;"boolean"==typeof t&&(n=t,t=!1),t=t||a;var r=k.exec(e),i=!n&&[];return r?[t.createElement(r[1])]:(r=x.buildFragment([e],t,i),i&&x(i).remove(),x.merge([],r.childNodes))},parseJSON:function(n){return e.JSON&&e.JSON.parse?e.JSON.parse(n):null===n?n:"string"==typeof n&&(n=x.trim(n),n&&E.test(n.replace(A,"@").replace(j,"]").replace(S,"")))?Function("return "+n)():(x.error("Invalid JSON: "+n),t)},parseXML:function(n){var r,i;if(!n||"string"!=typeof n)return null;try{e.DOMParser?(i=new DOMParser,r=i.parseFromString(n,"text/xml")):(r=new ActiveXObject("Microsoft.XMLDOM"),r.async="false",r.loadXML(n))}catch(o){r=t}return r&&r.documentElement&&!r.getElementsByTagName("parsererror").length||x.error("Invalid XML: "+n),r},noop:function(){},globalEval:function(t){t&&x.trim(t)&&(e.execScript||function(t){e.eval.call(e,t)})(t)},camelCase:function(e){return e.replace(D,"ms-").replace(L,H)},nodeName:function(e,t){return e.nodeName&&e.nodeName.toLowerCase()===t.toLowerCase()},each:function(e,t,n){var r,i=0,o=e.length,a=M(e);if(n){if(a){for(;o>i;i++)if(r=t.apply(e[i],n),r===!1)break}else for(i in e)if(r=t.apply(e[i],n),r===!1)break}else if(a){for(;o>i;i++)if(r=t.call(e[i],i,e[i]),r===!1)break}else for(i in e)if(r=t.call(e[i],i,e[i]),r===!1)break;return e},trim:b&&!b.call("\ufeff\u00a0")?function(e){return null==e?"":b.call(e)}:function(e){return null==e?"":(e+"").replace(C,"")},makeArray:function(e,t){var n=t||[];return null!=e&&(M(Object(e))?x.merge(n,"string"==typeof e?[e]:e):h.call(n,e)),n},inArray:function(e,t,n){var r;if(t){if(m)return m.call(t,e,n);for(r=t.length,n=n?0>n?Math.max(0,r+n):n:0;r>n;n++)if(n in t&&t[n]===e)return n}return-1},merge:function(e,n){var r=n.length,i=e.length,o=0;if("number"==typeof r)for(;r>o;o++)e[i++]=n[o];else while(n[o]!==t)e[i++]=n[o++];return e.length=i,e},grep:function(e,t,n){var r,i=[],o=0,a=e.length;for(n=!!n;a>o;o++)r=!!t(e[o],o),n!==r&&i.push(e[o]);return i},map:function(e,t,n){var r,i=0,o=e.length,a=M(e),s=[];if(a)for(;o>i;i++)r=t(e[i],i,n),null!=r&&(s[s.length]=r);else for(i in e)r=t(e[i],i,n),null!=r&&(s[s.length]=r);return d.apply([],s)},guid:1,proxy:function(e,n){var r,i,o;return"string"==typeof n&&(o=e[n],n=e,e=o),x.isFunction(e)?(r=g.call(arguments,2),i=function(){return e.apply(n||this,r.concat(g.call(arguments)))},i.guid=e.guid=e.guid||x.guid++,i):t},access:function(e,n,r,i,o,a,s){var l=0,u=e.length,c=null==r;if("object"===x.type(r)){o=!0;for(l in r)x.access(e,n,l,r[l],!0,a,s)}else if(i!==t&&(o=!0,x.isFunction(i)||(s=!0),c&&(s?(n.call(e,i),n=null):(c=n,n=function(e,t,n){return c.call(x(e),n)})),n))for(;u>l;l++)n(e[l],r,s?i:i.call(e[l],l,n(e[l],r)));return o?e:c?n.call(e):u?n(e[0],r):a},now:function(){return(new Date).getTime()},swap:function(e,t,n,r){var i,o,a={};for(o in t)a[o]=e.style[o],e.style[o]=t[o];i=n.apply(e,r||[]);for(o in t)e.style[o]=a[o];return i}}),x.ready.promise=function(t){if(!n)if(n=x.Deferred(),"complete"===a.readyState)setTimeout(x.ready);else if(a.addEventListener)a.addEventListener("DOMContentLoaded",q,!1),e.addEventListener("load",q,!1);else{a.attachEvent("onreadystatechange",q),e.attachEvent("onload",q);var r=!1;try{r=null==e.frameElement&&a.documentElement}catch(i){}r&&r.doScroll&&function o(){if(!x.isReady){try{r.doScroll("left")}catch(e){return setTimeout(o,50)}_(),x.ready()}}()}return n.promise(t)},x.each("Boolean Number String Function Array Date RegExp Object Error".split(" "),function(e,t){c["[object "+t+"]"]=t.toLowerCase()});function M(e){var t=e.length,n=x.type(e);return x.isWindow(e)?!1:1===e.nodeType&&t?!0:"array"===n||"function"!==n&&(0===t||"number"==typeof t&&t>0&&t-1 in e)}r=x(a),function(e,t){var n,r,i,o,a,s,l,u,c,p,f,d,h,g,m,y,v,b="sizzle"+-new Date,w=e.document,T=0,C=0,N=st(),k=st(),E=st(),S=!1,A=function(e,t){return e===t?(S=!0,0):0},j=typeof t,D=1<<31,L={}.hasOwnProperty,H=[],q=H.pop,_=H.push,M=H.push,O=H.slice,F=H.indexOf||function(e){var t=0,n=this.length;for(;n>t;t++)if(this[t]===e)return t;return-1},B="checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|ismap|loop|multiple|open|readonly|required|scoped",P="[\\x20\\t\\r\\n\\f]",R="(?:\\\\.|[\\w-]|[^\\x00-\\xa0])+",W=R.replace("w","w#"),$="\\["+P+"*("+R+")"+P+"*(?:([*^$|!~]?=)"+P+"*(?:(['\"])((?:\\\\.|[^\\\\])*?)\\3|("+W+")|)|)"+P+"*\\]",I=":("+R+")(?:\\(((['\"])((?:\\\\.|[^\\\\])*?)\\3|((?:\\\\.|[^\\\\()[\\]]|"+$.replace(3,8)+")*)|.*)\\)|)",z=RegExp("^"+P+"+|((?:^|[^\\\\])(?:\\\\.)*)"+P+"+$","g"),X=RegExp("^"+P+"*,"+P+"*"),U=RegExp("^"+P+"*([>+~]|"+P+")"+P+"*"),V=RegExp(P+"*[+~]"),Y=RegExp("="+P+"*([^\\]'\"]*)"+P+"*\\]","g"),J=RegExp(I),G=RegExp("^"+W+"$"),Q={ID:RegExp("^#("+R+")"),CLASS:RegExp("^\\.("+R+")"),TAG:RegExp("^("+R.replace("w","w*")+")"),ATTR:RegExp("^"+$),PSEUDO:RegExp("^"+I),CHILD:RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+P+"*(even|odd|(([+-]|)(\\d*)n|)"+P+"*(?:([+-]|)"+P+"*(\\d+)|))"+P+"*\\)|)","i"),bool:RegExp("^(?:"+B+")$","i"),needsContext:RegExp("^"+P+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+P+"*((?:-\\d)?\\d*)"+P+"*\\)|)(?=[^-]|$)","i")},K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,et=/^(?:input|select|textarea|button)$/i,tt=/^h\d$/i,nt=/'|\\/g,rt=RegExp("\\\\([\\da-f]{1,6}"+P+"?|("+P+")|.)","ig"),it=function(e,t,n){var r="0x"+t-65536;return r!==r||n?t:0>r?String.fromCharCode(r+65536):String.fromCharCode(55296|r>>10,56320|1023&r)};try{M.apply(H=O.call(w.childNodes),w.childNodes),H[w.childNodes.length].nodeType}catch(ot){M={apply:H.length?function(e,t){_.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function at(e,t,n,i){var o,a,s,l,u,c,d,m,y,x;if((t?t.ownerDocument||t:w)!==f&&p(t),t=t||f,n=n||[],!e||"string"!=typeof e)return n;if(1!==(l=t.nodeType)&&9!==l)return[];if(h&&!i){if(o=Z.exec(e))if(s=o[1]){if(9===l){if(a=t.getElementById(s),!a||!a.parentNode)return n;if(a.id===s)return n.push(a),n}else if(t.ownerDocument&&(a=t.ownerDocument.getElementById(s))&&v(t,a)&&a.id===s)return n.push(a),n}else{if(o[2])return M.apply(n,t.getElementsByTagName(e)),n;if((s=o[3])&&r.getElementsByClassName&&t.getElementsByClassName)return M.apply(n,t.getElementsByClassName(s)),n}if(r.qsa&&(!g||!g.test(e))){if(m=d=b,y=t,x=9===l&&e,1===l&&"object"!==t.nodeName.toLowerCase()){c=mt(e),(d=t.getAttribute("id"))?m=d.replace(nt,"\\$&"):t.setAttribute("id",m),m="[id='"+m+"'] ",u=c.length;while(u--)c[u]=m+yt(c[u]);y=V.test(e)&&t.parentNode||t,x=c.join(",")}if(x)try{return M.apply(n,y.querySelectorAll(x)),n}catch(T){}finally{d||t.removeAttribute("id")}}}return kt(e.replace(z,"$1"),t,n,i)}function st(){var e=[];function t(n,r){return e.push(n+=" ")>o.cacheLength&&delete t[e.shift()],t[n]=r}return t}function lt(e){return e[b]=!0,e}function ut(e){var t=f.createElement("div");try{return!!e(t)}catch(n){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function ct(e,t){var n=e.split("|"),r=e.length;while(r--)o.attrHandle[n[r]]=t}function pt(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&(~t.sourceIndex||D)-(~e.sourceIndex||D);if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function ft(e){return function(t){var n=t.nodeName.toLowerCase();return"input"===n&&t.type===e}}function dt(e){return function(t){var n=t.nodeName.toLowerCase();return("input"===n||"button"===n)&&t.type===e}}function ht(e){return lt(function(t){return t=+t,lt(function(n,r){var i,o=e([],n.length,t),a=o.length;while(a--)n[i=o[a]]&&(n[i]=!(r[i]=n[i]))})})}s=at.isXML=function(e){var t=e&&(e.ownerDocument||e).documentElement;return t?"HTML"!==t.nodeName:!1},r=at.support={},p=at.setDocument=function(e){var n=e?e.ownerDocument||e:w,i=n.defaultView;return n!==f&&9===n.nodeType&&n.documentElement?(f=n,d=n.documentElement,h=!s(n),i&&i.attachEvent&&i!==i.top&&i.attachEvent("onbeforeunload",function(){p()}),r.attributes=ut(function(e){return e.className="i",!e.getAttribute("className")}),r.getElementsByTagName=ut(function(e){return e.appendChild(n.createComment("")),!e.getElementsByTagName("*").length}),r.getElementsByClassName=ut(function(e){return e.innerHTML="
",e.firstChild.className="i",2===e.getElementsByClassName("i").length}),r.getById=ut(function(e){return d.appendChild(e).id=b,!n.getElementsByName||!n.getElementsByName(b).length}),r.getById?(o.find.ID=function(e,t){if(typeof t.getElementById!==j&&h){var n=t.getElementById(e);return n&&n.parentNode?[n]:[]}},o.filter.ID=function(e){var t=e.replace(rt,it);return function(e){return e.getAttribute("id")===t}}):(delete o.find.ID,o.filter.ID=function(e){var t=e.replace(rt,it);return function(e){var n=typeof e.getAttributeNode!==j&&e.getAttributeNode("id");return n&&n.value===t}}),o.find.TAG=r.getElementsByTagName?function(e,n){return typeof n.getElementsByTagName!==j?n.getElementsByTagName(e):t}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},o.find.CLASS=r.getElementsByClassName&&function(e,n){return typeof n.getElementsByClassName!==j&&h?n.getElementsByClassName(e):t},m=[],g=[],(r.qsa=K.test(n.querySelectorAll))&&(ut(function(e){e.innerHTML="",e.querySelectorAll("[selected]").length||g.push("\\["+P+"*(?:value|"+B+")"),e.querySelectorAll(":checked").length||g.push(":checked")}),ut(function(e){var t=n.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("t",""),e.querySelectorAll("[t^='']").length&&g.push("[*^$]="+P+"*(?:''|\"\")"),e.querySelectorAll(":enabled").length||g.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),g.push(",.*:")})),(r.matchesSelector=K.test(y=d.webkitMatchesSelector||d.mozMatchesSelector||d.oMatchesSelector||d.msMatchesSelector))&&ut(function(e){r.disconnectedMatch=y.call(e,"div"),y.call(e,"[s!='']:x"),m.push("!=",I)}),g=g.length&&RegExp(g.join("|")),m=m.length&&RegExp(m.join("|")),v=K.test(d.contains)||d.compareDocumentPosition?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},A=d.compareDocumentPosition?function(e,t){if(e===t)return S=!0,0;var i=t.compareDocumentPosition&&e.compareDocumentPosition&&e.compareDocumentPosition(t);return i?1&i||!r.sortDetached&&t.compareDocumentPosition(e)===i?e===n||v(w,e)?-1:t===n||v(w,t)?1:c?F.call(c,e)-F.call(c,t):0:4&i?-1:1:e.compareDocumentPosition?-1:1}:function(e,t){var r,i=0,o=e.parentNode,a=t.parentNode,s=[e],l=[t];if(e===t)return S=!0,0;if(!o||!a)return e===n?-1:t===n?1:o?-1:a?1:c?F.call(c,e)-F.call(c,t):0;if(o===a)return pt(e,t);r=e;while(r=r.parentNode)s.unshift(r);r=t;while(r=r.parentNode)l.unshift(r);while(s[i]===l[i])i++;return i?pt(s[i],l[i]):s[i]===w?-1:l[i]===w?1:0},n):f},at.matches=function(e,t){return at(e,null,null,t)},at.matchesSelector=function(e,t){if((e.ownerDocument||e)!==f&&p(e),t=t.replace(Y,"='$1']"),!(!r.matchesSelector||!h||m&&m.test(t)||g&&g.test(t)))try{var n=y.call(e,t);if(n||r.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(i){}return at(t,f,null,[e]).length>0},at.contains=function(e,t){return(e.ownerDocument||e)!==f&&p(e),v(e,t)},at.attr=function(e,n){(e.ownerDocument||e)!==f&&p(e);var i=o.attrHandle[n.toLowerCase()],a=i&&L.call(o.attrHandle,n.toLowerCase())?i(e,n,!h):t;return a===t?r.attributes||!h?e.getAttribute(n):(a=e.getAttributeNode(n))&&a.specified?a.value:null:a},at.error=function(e){throw Error("Syntax error, unrecognized expression: "+e)},at.uniqueSort=function(e){var t,n=[],i=0,o=0;if(S=!r.detectDuplicates,c=!r.sortStable&&e.slice(0),e.sort(A),S){while(t=e[o++])t===e[o]&&(i=n.push(o));while(i--)e.splice(n[i],1)}return e},a=at.getText=function(e){var t,n="",r=0,i=e.nodeType;if(i){if(1===i||9===i||11===i){if("string"==typeof e.textContent)return e.textContent;for(e=e.firstChild;e;e=e.nextSibling)n+=a(e)}else if(3===i||4===i)return e.nodeValue}else for(;t=e[r];r++)n+=a(t);return n},o=at.selectors={cacheLength:50,createPseudo:lt,match:Q,attrHandle:{},find:{},relative:{">":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(rt,it),e[3]=(e[4]||e[5]||"").replace(rt,it),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||at.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&at.error(e[0]),e},PSEUDO:function(e){var n,r=!e[5]&&e[2];return Q.CHILD.test(e[0])?null:(e[3]&&e[4]!==t?e[2]=e[4]:r&&J.test(r)&&(n=mt(r,!0))&&(n=r.indexOf(")",r.length-n)-r.length)&&(e[0]=e[0].slice(0,n),e[2]=r.slice(0,n)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(rt,it).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=N[e+" "];return t||(t=RegExp("(^|"+P+")"+e+"("+P+"|$)"))&&N(e,function(e){return t.test("string"==typeof e.className&&e.className||typeof e.getAttribute!==j&&e.getAttribute("class")||"")})},ATTR:function(e,t,n){return function(r){var i=at.attr(r,e);return null==i?"!="===t:t?(i+="","="===t?i===n:"!="===t?i!==n:"^="===t?n&&0===i.indexOf(n):"*="===t?n&&i.indexOf(n)>-1:"$="===t?n&&i.slice(-n.length)===n:"~="===t?(" "+i+" ").indexOf(n)>-1:"|="===t?i===n||i.slice(0,n.length+1)===n+"-":!1):!0}},CHILD:function(e,t,n,r,i){var o="nth"!==e.slice(0,3),a="last"!==e.slice(-4),s="of-type"===t;return 1===r&&0===i?function(e){return!!e.parentNode}:function(t,n,l){var u,c,p,f,d,h,g=o!==a?"nextSibling":"previousSibling",m=t.parentNode,y=s&&t.nodeName.toLowerCase(),v=!l&&!s;if(m){if(o){while(g){p=t;while(p=p[g])if(s?p.nodeName.toLowerCase()===y:1===p.nodeType)return!1;h=g="only"===e&&!h&&"nextSibling"}return!0}if(h=[a?m.firstChild:m.lastChild],a&&v){c=m[b]||(m[b]={}),u=c[e]||[],d=u[0]===T&&u[1],f=u[0]===T&&u[2],p=d&&m.childNodes[d];while(p=++d&&p&&p[g]||(f=d=0)||h.pop())if(1===p.nodeType&&++f&&p===t){c[e]=[T,d,f];break}}else if(v&&(u=(t[b]||(t[b]={}))[e])&&u[0]===T)f=u[1];else while(p=++d&&p&&p[g]||(f=d=0)||h.pop())if((s?p.nodeName.toLowerCase()===y:1===p.nodeType)&&++f&&(v&&((p[b]||(p[b]={}))[e]=[T,f]),p===t))break;return f-=i,f===r||0===f%r&&f/r>=0}}},PSEUDO:function(e,t){var n,r=o.pseudos[e]||o.setFilters[e.toLowerCase()]||at.error("unsupported pseudo: "+e);return r[b]?r(t):r.length>1?(n=[e,e,"",t],o.setFilters.hasOwnProperty(e.toLowerCase())?lt(function(e,n){var i,o=r(e,t),a=o.length;while(a--)i=F.call(e,o[a]),e[i]=!(n[i]=o[a])}):function(e){return r(e,0,n)}):r}},pseudos:{not:lt(function(e){var t=[],n=[],r=l(e.replace(z,"$1"));return r[b]?lt(function(e,t,n,i){var o,a=r(e,null,i,[]),s=e.length;while(s--)(o=a[s])&&(e[s]=!(t[s]=o))}):function(e,i,o){return t[0]=e,r(t,null,o,n),!n.pop()}}),has:lt(function(e){return function(t){return at(e,t).length>0}}),contains:lt(function(e){return function(t){return(t.textContent||t.innerText||a(t)).indexOf(e)>-1}}),lang:lt(function(e){return G.test(e||"")||at.error("unsupported lang: "+e),e=e.replace(rt,it).toLowerCase(),function(t){var n;do if(n=h?t.lang:t.getAttribute("xml:lang")||t.getAttribute("lang"))return n=n.toLowerCase(),n===e||0===n.indexOf(e+"-");while((t=t.parentNode)&&1===t.nodeType);return!1}}),target:function(t){var n=e.location&&e.location.hash;return n&&n.slice(1)===t.id},root:function(e){return e===d},focus:function(e){return e===f.activeElement&&(!f.hasFocus||f.hasFocus())&&!!(e.type||e.href||~e.tabIndex)},enabled:function(e){return e.disabled===!1},disabled:function(e){return e.disabled===!0},checked:function(e){var t=e.nodeName.toLowerCase();return"input"===t&&!!e.checked||"option"===t&&!!e.selected},selected:function(e){return e.parentNode&&e.parentNode.selectedIndex,e.selected===!0},empty:function(e){for(e=e.firstChild;e;e=e.nextSibling)if(e.nodeName>"@"||3===e.nodeType||4===e.nodeType)return!1;return!0},parent:function(e){return!o.pseudos.empty(e)},header:function(e){return tt.test(e.nodeName)},input:function(e){return et.test(e.nodeName)},button:function(e){var t=e.nodeName.toLowerCase();return"input"===t&&"button"===e.type||"button"===t},text:function(e){var t;return"input"===e.nodeName.toLowerCase()&&"text"===e.type&&(null==(t=e.getAttribute("type"))||t.toLowerCase()===e.type)},first:ht(function(){return[0]}),last:ht(function(e,t){return[t-1]}),eq:ht(function(e,t,n){return[0>n?n+t:n]}),even:ht(function(e,t){var n=0;for(;t>n;n+=2)e.push(n);return e}),odd:ht(function(e,t){var n=1;for(;t>n;n+=2)e.push(n);return e}),lt:ht(function(e,t,n){var r=0>n?n+t:n;for(;--r>=0;)e.push(r);return e}),gt:ht(function(e,t,n){var r=0>n?n+t:n;for(;t>++r;)e.push(r);return e})}},o.pseudos.nth=o.pseudos.eq;for(n in{radio:!0,checkbox:!0,file:!0,password:!0,image:!0})o.pseudos[n]=ft(n);for(n in{submit:!0,reset:!0})o.pseudos[n]=dt(n);function gt(){}gt.prototype=o.filters=o.pseudos,o.setFilters=new gt;function mt(e,t){var n,r,i,a,s,l,u,c=k[e+" "];if(c)return t?0:c.slice(0);s=e,l=[],u=o.preFilter;while(s){(!n||(r=X.exec(s)))&&(r&&(s=s.slice(r[0].length)||s),l.push(i=[])),n=!1,(r=U.exec(s))&&(n=r.shift(),i.push({value:n,type:r[0].replace(z," ")}),s=s.slice(n.length));for(a in o.filter)!(r=Q[a].exec(s))||u[a]&&!(r=u[a](r))||(n=r.shift(),i.push({value:n,type:a,matches:r}),s=s.slice(n.length));if(!n)break}return t?s.length:s?at.error(e):k(e,l).slice(0)}function yt(e){var t=0,n=e.length,r="";for(;n>t;t++)r+=e[t].value;return r}function vt(e,t,n){var r=t.dir,o=n&&"parentNode"===r,a=C++;return t.first?function(t,n,i){while(t=t[r])if(1===t.nodeType||o)return e(t,n,i)}:function(t,n,s){var l,u,c,p=T+" "+a;if(s){while(t=t[r])if((1===t.nodeType||o)&&e(t,n,s))return!0}else while(t=t[r])if(1===t.nodeType||o)if(c=t[b]||(t[b]={}),(u=c[r])&&u[0]===p){if((l=u[1])===!0||l===i)return l===!0}else if(u=c[r]=[p],u[1]=e(t,n,s)||i,u[1]===!0)return!0}}function bt(e){return e.length>1?function(t,n,r){var i=e.length;while(i--)if(!e[i](t,n,r))return!1;return!0}:e[0]}function xt(e,t,n,r,i){var o,a=[],s=0,l=e.length,u=null!=t;for(;l>s;s++)(o=e[s])&&(!n||n(o,r,i))&&(a.push(o),u&&t.push(s));return a}function wt(e,t,n,r,i,o){return r&&!r[b]&&(r=wt(r)),i&&!i[b]&&(i=wt(i,o)),lt(function(o,a,s,l){var u,c,p,f=[],d=[],h=a.length,g=o||Nt(t||"*",s.nodeType?[s]:s,[]),m=!e||!o&&t?g:xt(g,f,e,s,l),y=n?i||(o?e:h||r)?[]:a:m;if(n&&n(m,y,s,l),r){u=xt(y,d),r(u,[],s,l),c=u.length;while(c--)(p=u[c])&&(y[d[c]]=!(m[d[c]]=p))}if(o){if(i||e){if(i){u=[],c=y.length;while(c--)(p=y[c])&&u.push(m[c]=p);i(null,y=[],u,l)}c=y.length;while(c--)(p=y[c])&&(u=i?F.call(o,p):f[c])>-1&&(o[u]=!(a[u]=p))}}else y=xt(y===a?y.splice(h,y.length):y),i?i(null,a,y,l):M.apply(a,y)})}function Tt(e){var t,n,r,i=e.length,a=o.relative[e[0].type],s=a||o.relative[" "],l=a?1:0,c=vt(function(e){return e===t},s,!0),p=vt(function(e){return F.call(t,e)>-1},s,!0),f=[function(e,n,r){return!a&&(r||n!==u)||((t=n).nodeType?c(e,n,r):p(e,n,r))}];for(;i>l;l++)if(n=o.relative[e[l].type])f=[vt(bt(f),n)];else{if(n=o.filter[e[l].type].apply(null,e[l].matches),n[b]){for(r=++l;i>r;r++)if(o.relative[e[r].type])break;return wt(l>1&&bt(f),l>1&&yt(e.slice(0,l-1).concat({value:" "===e[l-2].type?"*":""})).replace(z,"$1"),n,r>l&&Tt(e.slice(l,r)),i>r&&Tt(e=e.slice(r)),i>r&&yt(e))}f.push(n)}return bt(f)}function Ct(e,t){var n=0,r=t.length>0,a=e.length>0,s=function(s,l,c,p,d){var h,g,m,y=[],v=0,b="0",x=s&&[],w=null!=d,C=u,N=s||a&&o.find.TAG("*",d&&l.parentNode||l),k=T+=null==C?1:Math.random()||.1;for(w&&(u=l!==f&&l,i=n);null!=(h=N[b]);b++){if(a&&h){g=0;while(m=e[g++])if(m(h,l,c)){p.push(h);break}w&&(T=k,i=++n)}r&&((h=!m&&h)&&v--,s&&x.push(h))}if(v+=b,r&&b!==v){g=0;while(m=t[g++])m(x,y,l,c);if(s){if(v>0)while(b--)x[b]||y[b]||(y[b]=q.call(p));y=xt(y)}M.apply(p,y),w&&!s&&y.length>0&&v+t.length>1&&at.uniqueSort(p)}return w&&(T=k,u=C),x};return r?lt(s):s}l=at.compile=function(e,t){var n,r=[],i=[],o=E[e+" "];if(!o){t||(t=mt(e)),n=t.length;while(n--)o=Tt(t[n]),o[b]?r.push(o):i.push(o);o=E(e,Ct(i,r))}return o};function Nt(e,t,n){var r=0,i=t.length;for(;i>r;r++)at(e,t[r],n);return n}function kt(e,t,n,i){var a,s,u,c,p,f=mt(e);if(!i&&1===f.length){if(s=f[0]=f[0].slice(0),s.length>2&&"ID"===(u=s[0]).type&&r.getById&&9===t.nodeType&&h&&o.relative[s[1].type]){if(t=(o.find.ID(u.matches[0].replace(rt,it),t)||[])[0],!t)return n;e=e.slice(s.shift().value.length)}a=Q.needsContext.test(e)?0:s.length;while(a--){if(u=s[a],o.relative[c=u.type])break;if((p=o.find[c])&&(i=p(u.matches[0].replace(rt,it),V.test(s[0].type)&&t.parentNode||t))){if(s.splice(a,1),e=i.length&&yt(s),!e)return M.apply(n,i),n;break}}}return l(e,f)(i,t,!h,n,V.test(e)),n}r.sortStable=b.split("").sort(A).join("")===b,r.detectDuplicates=S,p(),r.sortDetached=ut(function(e){return 1&e.compareDocumentPosition(f.createElement("div"))}),ut(function(e){return e.innerHTML="","#"===e.firstChild.getAttribute("href")})||ct("type|href|height|width",function(e,n,r){return r?t:e.getAttribute(n,"type"===n.toLowerCase()?1:2)}),r.attributes&&ut(function(e){return e.innerHTML="",e.firstChild.setAttribute("value",""),""===e.firstChild.getAttribute("value")})||ct("value",function(e,n,r){return r||"input"!==e.nodeName.toLowerCase()?t:e.defaultValue}),ut(function(e){return null==e.getAttribute("disabled")})||ct(B,function(e,n,r){var i;return r?t:(i=e.getAttributeNode(n))&&i.specified?i.value:e[n]===!0?n.toLowerCase():null}),x.find=at,x.expr=at.selectors,x.expr[":"]=x.expr.pseudos,x.unique=at.uniqueSort,x.text=at.getText,x.isXMLDoc=at.isXML,x.contains=at.contains}(e);var O={};function F(e){var t=O[e]={};return x.each(e.match(T)||[],function(e,n){t[n]=!0}),t}x.Callbacks=function(e){e="string"==typeof e?O[e]||F(e):x.extend({},e);var n,r,i,o,a,s,l=[],u=!e.once&&[],c=function(t){for(r=e.memory&&t,i=!0,a=s||0,s=0,o=l.length,n=!0;l&&o>a;a++)if(l[a].apply(t[0],t[1])===!1&&e.stopOnFalse){r=!1;break}n=!1,l&&(u?u.length&&c(u.shift()):r?l=[]:p.disable())},p={add:function(){if(l){var t=l.length;(function i(t){x.each(t,function(t,n){var r=x.type(n);"function"===r?e.unique&&p.has(n)||l.push(n):n&&n.length&&"string"!==r&&i(n)})})(arguments),n?o=l.length:r&&(s=t,c(r))}return this},remove:function(){return l&&x.each(arguments,function(e,t){var r;while((r=x.inArray(t,l,r))>-1)l.splice(r,1),n&&(o>=r&&o--,a>=r&&a--)}),this},has:function(e){return e?x.inArray(e,l)>-1:!(!l||!l.length)},empty:function(){return l=[],o=0,this},disable:function(){return l=u=r=t,this},disabled:function(){return!l},lock:function(){return u=t,r||p.disable(),this},locked:function(){return!u},fireWith:function(e,t){return!l||i&&!u||(t=t||[],t=[e,t.slice?t.slice():t],n?u.push(t):c(t)),this},fire:function(){return p.fireWith(this,arguments),this},fired:function(){return!!i}};return p},x.extend({Deferred:function(e){var t=[["resolve","done",x.Callbacks("once memory"),"resolved"],["reject","fail",x.Callbacks("once memory"),"rejected"],["notify","progress",x.Callbacks("memory")]],n="pending",r={state:function(){return n},always:function(){return i.done(arguments).fail(arguments),this},then:function(){var e=arguments;return x.Deferred(function(n){x.each(t,function(t,o){var a=o[0],s=x.isFunction(e[t])&&e[t];i[o[1]](function(){var e=s&&s.apply(this,arguments);e&&x.isFunction(e.promise)?e.promise().done(n.resolve).fail(n.reject).progress(n.notify):n[a+"With"](this===r?n.promise():this,s?[e]:arguments)})}),e=null}).promise()},promise:function(e){return null!=e?x.extend(e,r):r}},i={};return r.pipe=r.then,x.each(t,function(e,o){var a=o[2],s=o[3];r[o[1]]=a.add,s&&a.add(function(){n=s},t[1^e][2].disable,t[2][2].lock),i[o[0]]=function(){return i[o[0]+"With"](this===i?r:this,arguments),this},i[o[0]+"With"]=a.fireWith}),r.promise(i),e&&e.call(i,i),i},when:function(e){var t=0,n=g.call(arguments),r=n.length,i=1!==r||e&&x.isFunction(e.promise)?r:0,o=1===i?e:x.Deferred(),a=function(e,t,n){return function(r){t[e]=this,n[e]=arguments.length>1?g.call(arguments):r,n===s?o.notifyWith(t,n):--i||o.resolveWith(t,n)}},s,l,u;if(r>1)for(s=Array(r),l=Array(r),u=Array(r);r>t;t++)n[t]&&x.isFunction(n[t].promise)?n[t].promise().done(a(t,u,n)).fail(o.reject).progress(a(t,l,s)):--i;return i||o.resolveWith(u,n),o.promise()}}),x.support=function(t){var n,r,o,s,l,u,c,p,f,d=a.createElement("div");if(d.setAttribute("className","t"),d.innerHTML="
a",n=d.getElementsByTagName("*")||[],r=d.getElementsByTagName("a")[0],!r||!r.style||!n.length)return t;s=a.createElement("select"),u=s.appendChild(a.createElement("option")),o=d.getElementsByTagName("input")[0],r.style.cssText="top:1px;float:left;opacity:.5",t.getSetAttribute="t"!==d.className,t.leadingWhitespace=3===d.firstChild.nodeType,t.tbody=!d.getElementsByTagName("tbody").length,t.htmlSerialize=!!d.getElementsByTagName("link").length,t.style=/top/.test(r.getAttribute("style")),t.hrefNormalized="/a"===r.getAttribute("href"),t.opacity=/^0.5/.test(r.style.opacity),t.cssFloat=!!r.style.cssFloat,t.checkOn=!!o.value,t.optSelected=u.selected,t.enctype=!!a.createElement("form").enctype,t.html5Clone="<:nav>"!==a.createElement("nav").cloneNode(!0).outerHTML,t.inlineBlockNeedsLayout=!1,t.shrinkWrapBlocks=!1,t.pixelPosition=!1,t.deleteExpando=!0,t.noCloneEvent=!0,t.reliableMarginRight=!0,t.boxSizingReliable=!0,o.checked=!0,t.noCloneChecked=o.cloneNode(!0).checked,s.disabled=!0,t.optDisabled=!u.disabled;try{delete d.test}catch(h){t.deleteExpando=!1}o=a.createElement("input"),o.setAttribute("value",""),t.input=""===o.getAttribute("value"),o.value="t",o.setAttribute("type","radio"),t.radioValue="t"===o.value,o.setAttribute("checked","t"),o.setAttribute("name","t"),l=a.createDocumentFragment(),l.appendChild(o),t.appendChecked=o.checked,t.checkClone=l.cloneNode(!0).cloneNode(!0).lastChild.checked,d.attachEvent&&(d.attachEvent("onclick",function(){t.noCloneEvent=!1}),d.cloneNode(!0).click());for(f in{submit:!0,change:!0,focusin:!0})d.setAttribute(c="on"+f,"t"),t[f+"Bubbles"]=c in e||d.attributes[c].expando===!1;d.style.backgroundClip="content-box",d.cloneNode(!0).style.backgroundClip="",t.clearCloneStyle="content-box"===d.style.backgroundClip;for(f in x(t))break;return t.ownLast="0"!==f,x(function(){var n,r,o,s="padding:0;margin:0;border:0;display:block;box-sizing:content-box;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;",l=a.getElementsByTagName("body")[0];l&&(n=a.createElement("div"),n.style.cssText="border:0;width:0;height:0;position:absolute;top:0;left:-9999px;margin-top:1px",l.appendChild(n).appendChild(d),d.innerHTML="
t
",o=d.getElementsByTagName("td"),o[0].style.cssText="padding:0;margin:0;border:0;display:none",p=0===o[0].offsetHeight,o[0].style.display="",o[1].style.display="none",t.reliableHiddenOffsets=p&&0===o[0].offsetHeight,d.innerHTML="",d.style.cssText="box-sizing:border-box;-moz-box-sizing:border-box;-webkit-box-sizing:border-box;padding:1px;border:1px;display:block;width:4px;margin-top:1%;position:absolute;top:1%;",x.swap(l,null!=l.style.zoom?{zoom:1}:{},function(){t.boxSizing=4===d.offsetWidth}),e.getComputedStyle&&(t.pixelPosition="1%"!==(e.getComputedStyle(d,null)||{}).top,t.boxSizingReliable="4px"===(e.getComputedStyle(d,null)||{width:"4px"}).width,r=d.appendChild(a.createElement("div")),r.style.cssText=d.style.cssText=s,r.style.marginRight=r.style.width="0",d.style.width="1px",t.reliableMarginRight=!parseFloat((e.getComputedStyle(r,null)||{}).marginRight)),typeof d.style.zoom!==i&&(d.innerHTML="",d.style.cssText=s+"width:1px;padding:1px;display:inline;zoom:1",t.inlineBlockNeedsLayout=3===d.offsetWidth,d.style.display="block",d.innerHTML="
",d.firstChild.style.width="5px",t.shrinkWrapBlocks=3!==d.offsetWidth,t.inlineBlockNeedsLayout&&(l.style.zoom=1)),l.removeChild(n),n=d=o=r=null)}),n=s=l=u=r=o=null,t -}({});var B=/(?:\{[\s\S]*\}|\[[\s\S]*\])$/,P=/([A-Z])/g;function R(e,n,r,i){if(x.acceptData(e)){var o,a,s=x.expando,l=e.nodeType,u=l?x.cache:e,c=l?e[s]:e[s]&&s;if(c&&u[c]&&(i||u[c].data)||r!==t||"string"!=typeof n)return c||(c=l?e[s]=p.pop()||x.guid++:s),u[c]||(u[c]=l?{}:{toJSON:x.noop}),("object"==typeof n||"function"==typeof n)&&(i?u[c]=x.extend(u[c],n):u[c].data=x.extend(u[c].data,n)),a=u[c],i||(a.data||(a.data={}),a=a.data),r!==t&&(a[x.camelCase(n)]=r),"string"==typeof n?(o=a[n],null==o&&(o=a[x.camelCase(n)])):o=a,o}}function W(e,t,n){if(x.acceptData(e)){var r,i,o=e.nodeType,a=o?x.cache:e,s=o?e[x.expando]:x.expando;if(a[s]){if(t&&(r=n?a[s]:a[s].data)){x.isArray(t)?t=t.concat(x.map(t,x.camelCase)):t in r?t=[t]:(t=x.camelCase(t),t=t in r?[t]:t.split(" ")),i=t.length;while(i--)delete r[t[i]];if(n?!I(r):!x.isEmptyObject(r))return}(n||(delete a[s].data,I(a[s])))&&(o?x.cleanData([e],!0):x.support.deleteExpando||a!=a.window?delete a[s]:a[s]=null)}}}x.extend({cache:{},noData:{applet:!0,embed:!0,object:"clsid:D27CDB6E-AE6D-11cf-96B8-444553540000"},hasData:function(e){return e=e.nodeType?x.cache[e[x.expando]]:e[x.expando],!!e&&!I(e)},data:function(e,t,n){return R(e,t,n)},removeData:function(e,t){return W(e,t)},_data:function(e,t,n){return R(e,t,n,!0)},_removeData:function(e,t){return W(e,t,!0)},acceptData:function(e){if(e.nodeType&&1!==e.nodeType&&9!==e.nodeType)return!1;var t=e.nodeName&&x.noData[e.nodeName.toLowerCase()];return!t||t!==!0&&e.getAttribute("classid")===t}}),x.fn.extend({data:function(e,n){var r,i,o=null,a=0,s=this[0];if(e===t){if(this.length&&(o=x.data(s),1===s.nodeType&&!x._data(s,"parsedAttrs"))){for(r=s.attributes;r.length>a;a++)i=r[a].name,0===i.indexOf("data-")&&(i=x.camelCase(i.slice(5)),$(s,i,o[i]));x._data(s,"parsedAttrs",!0)}return o}return"object"==typeof e?this.each(function(){x.data(this,e)}):arguments.length>1?this.each(function(){x.data(this,e,n)}):s?$(s,e,x.data(s,e)):null},removeData:function(e){return this.each(function(){x.removeData(this,e)})}});function $(e,n,r){if(r===t&&1===e.nodeType){var i="data-"+n.replace(P,"-$1").toLowerCase();if(r=e.getAttribute(i),"string"==typeof r){try{r="true"===r?!0:"false"===r?!1:"null"===r?null:+r+""===r?+r:B.test(r)?x.parseJSON(r):r}catch(o){}x.data(e,n,r)}else r=t}return r}function I(e){var t;for(t in e)if(("data"!==t||!x.isEmptyObject(e[t]))&&"toJSON"!==t)return!1;return!0}x.extend({queue:function(e,n,r){var i;return e?(n=(n||"fx")+"queue",i=x._data(e,n),r&&(!i||x.isArray(r)?i=x._data(e,n,x.makeArray(r)):i.push(r)),i||[]):t},dequeue:function(e,t){t=t||"fx";var n=x.queue(e,t),r=n.length,i=n.shift(),o=x._queueHooks(e,t),a=function(){x.dequeue(e,t)};"inprogress"===i&&(i=n.shift(),r--),i&&("fx"===t&&n.unshift("inprogress"),delete o.stop,i.call(e,a,o)),!r&&o&&o.empty.fire()},_queueHooks:function(e,t){var n=t+"queueHooks";return x._data(e,n)||x._data(e,n,{empty:x.Callbacks("once memory").add(function(){x._removeData(e,t+"queue"),x._removeData(e,n)})})}}),x.fn.extend({queue:function(e,n){var r=2;return"string"!=typeof e&&(n=e,e="fx",r--),r>arguments.length?x.queue(this[0],e):n===t?this:this.each(function(){var t=x.queue(this,e,n);x._queueHooks(this,e),"fx"===e&&"inprogress"!==t[0]&&x.dequeue(this,e)})},dequeue:function(e){return this.each(function(){x.dequeue(this,e)})},delay:function(e,t){return e=x.fx?x.fx.speeds[e]||e:e,t=t||"fx",this.queue(t,function(t,n){var r=setTimeout(t,e);n.stop=function(){clearTimeout(r)}})},clearQueue:function(e){return this.queue(e||"fx",[])},promise:function(e,n){var r,i=1,o=x.Deferred(),a=this,s=this.length,l=function(){--i||o.resolveWith(a,[a])};"string"!=typeof e&&(n=e,e=t),e=e||"fx";while(s--)r=x._data(a[s],e+"queueHooks"),r&&r.empty&&(i++,r.empty.add(l));return l(),o.promise(n)}});var z,X,U=/[\t\r\n\f]/g,V=/\r/g,Y=/^(?:input|select|textarea|button|object)$/i,J=/^(?:a|area)$/i,G=/^(?:checked|selected)$/i,Q=x.support.getSetAttribute,K=x.support.input;x.fn.extend({attr:function(e,t){return x.access(this,x.attr,e,t,arguments.length>1)},removeAttr:function(e){return this.each(function(){x.removeAttr(this,e)})},prop:function(e,t){return x.access(this,x.prop,e,t,arguments.length>1)},removeProp:function(e){return e=x.propFix[e]||e,this.each(function(){try{this[e]=t,delete this[e]}catch(n){}})},addClass:function(e){var t,n,r,i,o,a=0,s=this.length,l="string"==typeof e&&e;if(x.isFunction(e))return this.each(function(t){x(this).addClass(e.call(this,t,this.className))});if(l)for(t=(e||"").match(T)||[];s>a;a++)if(n=this[a],r=1===n.nodeType&&(n.className?(" "+n.className+" ").replace(U," "):" ")){o=0;while(i=t[o++])0>r.indexOf(" "+i+" ")&&(r+=i+" ");n.className=x.trim(r)}return this},removeClass:function(e){var t,n,r,i,o,a=0,s=this.length,l=0===arguments.length||"string"==typeof e&&e;if(x.isFunction(e))return this.each(function(t){x(this).removeClass(e.call(this,t,this.className))});if(l)for(t=(e||"").match(T)||[];s>a;a++)if(n=this[a],r=1===n.nodeType&&(n.className?(" "+n.className+" ").replace(U," "):"")){o=0;while(i=t[o++])while(r.indexOf(" "+i+" ")>=0)r=r.replace(" "+i+" "," ");n.className=e?x.trim(r):""}return this},toggleClass:function(e,t){var n=typeof e;return"boolean"==typeof t&&"string"===n?t?this.addClass(e):this.removeClass(e):x.isFunction(e)?this.each(function(n){x(this).toggleClass(e.call(this,n,this.className,t),t)}):this.each(function(){if("string"===n){var t,r=0,o=x(this),a=e.match(T)||[];while(t=a[r++])o.hasClass(t)?o.removeClass(t):o.addClass(t)}else(n===i||"boolean"===n)&&(this.className&&x._data(this,"__className__",this.className),this.className=this.className||e===!1?"":x._data(this,"__className__")||"")})},hasClass:function(e){var t=" "+e+" ",n=0,r=this.length;for(;r>n;n++)if(1===this[n].nodeType&&(" "+this[n].className+" ").replace(U," ").indexOf(t)>=0)return!0;return!1},val:function(e){var n,r,i,o=this[0];{if(arguments.length)return i=x.isFunction(e),this.each(function(n){var o;1===this.nodeType&&(o=i?e.call(this,n,x(this).val()):e,null==o?o="":"number"==typeof o?o+="":x.isArray(o)&&(o=x.map(o,function(e){return null==e?"":e+""})),r=x.valHooks[this.type]||x.valHooks[this.nodeName.toLowerCase()],r&&"set"in r&&r.set(this,o,"value")!==t||(this.value=o))});if(o)return r=x.valHooks[o.type]||x.valHooks[o.nodeName.toLowerCase()],r&&"get"in r&&(n=r.get(o,"value"))!==t?n:(n=o.value,"string"==typeof n?n.replace(V,""):null==n?"":n)}}}),x.extend({valHooks:{option:{get:function(e){var t=x.find.attr(e,"value");return null!=t?t:e.text}},select:{get:function(e){var t,n,r=e.options,i=e.selectedIndex,o="select-one"===e.type||0>i,a=o?null:[],s=o?i+1:r.length,l=0>i?s:o?i:0;for(;s>l;l++)if(n=r[l],!(!n.selected&&l!==i||(x.support.optDisabled?n.disabled:null!==n.getAttribute("disabled"))||n.parentNode.disabled&&x.nodeName(n.parentNode,"optgroup"))){if(t=x(n).val(),o)return t;a.push(t)}return a},set:function(e,t){var n,r,i=e.options,o=x.makeArray(t),a=i.length;while(a--)r=i[a],(r.selected=x.inArray(x(r).val(),o)>=0)&&(n=!0);return n||(e.selectedIndex=-1),o}}},attr:function(e,n,r){var o,a,s=e.nodeType;if(e&&3!==s&&8!==s&&2!==s)return typeof e.getAttribute===i?x.prop(e,n,r):(1===s&&x.isXMLDoc(e)||(n=n.toLowerCase(),o=x.attrHooks[n]||(x.expr.match.bool.test(n)?X:z)),r===t?o&&"get"in o&&null!==(a=o.get(e,n))?a:(a=x.find.attr(e,n),null==a?t:a):null!==r?o&&"set"in o&&(a=o.set(e,r,n))!==t?a:(e.setAttribute(n,r+""),r):(x.removeAttr(e,n),t))},removeAttr:function(e,t){var n,r,i=0,o=t&&t.match(T);if(o&&1===e.nodeType)while(n=o[i++])r=x.propFix[n]||n,x.expr.match.bool.test(n)?K&&Q||!G.test(n)?e[r]=!1:e[x.camelCase("default-"+n)]=e[r]=!1:x.attr(e,n,""),e.removeAttribute(Q?n:r)},attrHooks:{type:{set:function(e,t){if(!x.support.radioValue&&"radio"===t&&x.nodeName(e,"input")){var n=e.value;return e.setAttribute("type",t),n&&(e.value=n),t}}}},propFix:{"for":"htmlFor","class":"className"},prop:function(e,n,r){var i,o,a,s=e.nodeType;if(e&&3!==s&&8!==s&&2!==s)return a=1!==s||!x.isXMLDoc(e),a&&(n=x.propFix[n]||n,o=x.propHooks[n]),r!==t?o&&"set"in o&&(i=o.set(e,r,n))!==t?i:e[n]=r:o&&"get"in o&&null!==(i=o.get(e,n))?i:e[n]},propHooks:{tabIndex:{get:function(e){var t=x.find.attr(e,"tabindex");return t?parseInt(t,10):Y.test(e.nodeName)||J.test(e.nodeName)&&e.href?0:-1}}}}),X={set:function(e,t,n){return t===!1?x.removeAttr(e,n):K&&Q||!G.test(n)?e.setAttribute(!Q&&x.propFix[n]||n,n):e[x.camelCase("default-"+n)]=e[n]=!0,n}},x.each(x.expr.match.bool.source.match(/\w+/g),function(e,n){var r=x.expr.attrHandle[n]||x.find.attr;x.expr.attrHandle[n]=K&&Q||!G.test(n)?function(e,n,i){var o=x.expr.attrHandle[n],a=i?t:(x.expr.attrHandle[n]=t)!=r(e,n,i)?n.toLowerCase():null;return x.expr.attrHandle[n]=o,a}:function(e,n,r){return r?t:e[x.camelCase("default-"+n)]?n.toLowerCase():null}}),K&&Q||(x.attrHooks.value={set:function(e,n,r){return x.nodeName(e,"input")?(e.defaultValue=n,t):z&&z.set(e,n,r)}}),Q||(z={set:function(e,n,r){var i=e.getAttributeNode(r);return i||e.setAttributeNode(i=e.ownerDocument.createAttribute(r)),i.value=n+="","value"===r||n===e.getAttribute(r)?n:t}},x.expr.attrHandle.id=x.expr.attrHandle.name=x.expr.attrHandle.coords=function(e,n,r){var i;return r?t:(i=e.getAttributeNode(n))&&""!==i.value?i.value:null},x.valHooks.button={get:function(e,n){var r=e.getAttributeNode(n);return r&&r.specified?r.value:t},set:z.set},x.attrHooks.contenteditable={set:function(e,t,n){z.set(e,""===t?!1:t,n)}},x.each(["width","height"],function(e,n){x.attrHooks[n]={set:function(e,r){return""===r?(e.setAttribute(n,"auto"),r):t}}})),x.support.hrefNormalized||x.each(["href","src"],function(e,t){x.propHooks[t]={get:function(e){return e.getAttribute(t,4)}}}),x.support.style||(x.attrHooks.style={get:function(e){return e.style.cssText||t},set:function(e,t){return e.style.cssText=t+""}}),x.support.optSelected||(x.propHooks.selected={get:function(e){var t=e.parentNode;return t&&(t.selectedIndex,t.parentNode&&t.parentNode.selectedIndex),null}}),x.each(["tabIndex","readOnly","maxLength","cellSpacing","cellPadding","rowSpan","colSpan","useMap","frameBorder","contentEditable"],function(){x.propFix[this.toLowerCase()]=this}),x.support.enctype||(x.propFix.enctype="encoding"),x.each(["radio","checkbox"],function(){x.valHooks[this]={set:function(e,n){return x.isArray(n)?e.checked=x.inArray(x(e).val(),n)>=0:t}},x.support.checkOn||(x.valHooks[this].get=function(e){return null===e.getAttribute("value")?"on":e.value})});var Z=/^(?:input|select|textarea)$/i,et=/^key/,tt=/^(?:mouse|contextmenu)|click/,nt=/^(?:focusinfocus|focusoutblur)$/,rt=/^([^.]*)(?:\.(.+)|)$/;function it(){return!0}function ot(){return!1}function at(){try{return a.activeElement}catch(e){}}x.event={global:{},add:function(e,n,r,o,a){var s,l,u,c,p,f,d,h,g,m,y,v=x._data(e);if(v){r.handler&&(c=r,r=c.handler,a=c.selector),r.guid||(r.guid=x.guid++),(l=v.events)||(l=v.events={}),(f=v.handle)||(f=v.handle=function(e){return typeof x===i||e&&x.event.triggered===e.type?t:x.event.dispatch.apply(f.elem,arguments)},f.elem=e),n=(n||"").match(T)||[""],u=n.length;while(u--)s=rt.exec(n[u])||[],g=y=s[1],m=(s[2]||"").split(".").sort(),g&&(p=x.event.special[g]||{},g=(a?p.delegateType:p.bindType)||g,p=x.event.special[g]||{},d=x.extend({type:g,origType:y,data:o,handler:r,guid:r.guid,selector:a,needsContext:a&&x.expr.match.needsContext.test(a),namespace:m.join(".")},c),(h=l[g])||(h=l[g]=[],h.delegateCount=0,p.setup&&p.setup.call(e,o,m,f)!==!1||(e.addEventListener?e.addEventListener(g,f,!1):e.attachEvent&&e.attachEvent("on"+g,f))),p.add&&(p.add.call(e,d),d.handler.guid||(d.handler.guid=r.guid)),a?h.splice(h.delegateCount++,0,d):h.push(d),x.event.global[g]=!0);e=null}},remove:function(e,t,n,r,i){var o,a,s,l,u,c,p,f,d,h,g,m=x.hasData(e)&&x._data(e);if(m&&(c=m.events)){t=(t||"").match(T)||[""],u=t.length;while(u--)if(s=rt.exec(t[u])||[],d=g=s[1],h=(s[2]||"").split(".").sort(),d){p=x.event.special[d]||{},d=(r?p.delegateType:p.bindType)||d,f=c[d]||[],s=s[2]&&RegExp("(^|\\.)"+h.join("\\.(?:.*\\.|)")+"(\\.|$)"),l=o=f.length;while(o--)a=f[o],!i&&g!==a.origType||n&&n.guid!==a.guid||s&&!s.test(a.namespace)||r&&r!==a.selector&&("**"!==r||!a.selector)||(f.splice(o,1),a.selector&&f.delegateCount--,p.remove&&p.remove.call(e,a));l&&!f.length&&(p.teardown&&p.teardown.call(e,h,m.handle)!==!1||x.removeEvent(e,d,m.handle),delete c[d])}else for(d in c)x.event.remove(e,d+t[u],n,r,!0);x.isEmptyObject(c)&&(delete m.handle,x._removeData(e,"events"))}},trigger:function(n,r,i,o){var s,l,u,c,p,f,d,h=[i||a],g=v.call(n,"type")?n.type:n,m=v.call(n,"namespace")?n.namespace.split("."):[];if(u=f=i=i||a,3!==i.nodeType&&8!==i.nodeType&&!nt.test(g+x.event.triggered)&&(g.indexOf(".")>=0&&(m=g.split("."),g=m.shift(),m.sort()),l=0>g.indexOf(":")&&"on"+g,n=n[x.expando]?n:new x.Event(g,"object"==typeof n&&n),n.isTrigger=o?2:3,n.namespace=m.join("."),n.namespace_re=n.namespace?RegExp("(^|\\.)"+m.join("\\.(?:.*\\.|)")+"(\\.|$)"):null,n.result=t,n.target||(n.target=i),r=null==r?[n]:x.makeArray(r,[n]),p=x.event.special[g]||{},o||!p.trigger||p.trigger.apply(i,r)!==!1)){if(!o&&!p.noBubble&&!x.isWindow(i)){for(c=p.delegateType||g,nt.test(c+g)||(u=u.parentNode);u;u=u.parentNode)h.push(u),f=u;f===(i.ownerDocument||a)&&h.push(f.defaultView||f.parentWindow||e)}d=0;while((u=h[d++])&&!n.isPropagationStopped())n.type=d>1?c:p.bindType||g,s=(x._data(u,"events")||{})[n.type]&&x._data(u,"handle"),s&&s.apply(u,r),s=l&&u[l],s&&x.acceptData(u)&&s.apply&&s.apply(u,r)===!1&&n.preventDefault();if(n.type=g,!o&&!n.isDefaultPrevented()&&(!p._default||p._default.apply(h.pop(),r)===!1)&&x.acceptData(i)&&l&&i[g]&&!x.isWindow(i)){f=i[l],f&&(i[l]=null),x.event.triggered=g;try{i[g]()}catch(y){}x.event.triggered=t,f&&(i[l]=f)}return n.result}},dispatch:function(e){e=x.event.fix(e);var n,r,i,o,a,s=[],l=g.call(arguments),u=(x._data(this,"events")||{})[e.type]||[],c=x.event.special[e.type]||{};if(l[0]=e,e.delegateTarget=this,!c.preDispatch||c.preDispatch.call(this,e)!==!1){s=x.event.handlers.call(this,e,u),n=0;while((o=s[n++])&&!e.isPropagationStopped()){e.currentTarget=o.elem,a=0;while((i=o.handlers[a++])&&!e.isImmediatePropagationStopped())(!e.namespace_re||e.namespace_re.test(i.namespace))&&(e.handleObj=i,e.data=i.data,r=((x.event.special[i.origType]||{}).handle||i.handler).apply(o.elem,l),r!==t&&(e.result=r)===!1&&(e.preventDefault(),e.stopPropagation()))}return c.postDispatch&&c.postDispatch.call(this,e),e.result}},handlers:function(e,n){var r,i,o,a,s=[],l=n.delegateCount,u=e.target;if(l&&u.nodeType&&(!e.button||"click"!==e.type))for(;u!=this;u=u.parentNode||this)if(1===u.nodeType&&(u.disabled!==!0||"click"!==e.type)){for(o=[],a=0;l>a;a++)i=n[a],r=i.selector+" ",o[r]===t&&(o[r]=i.needsContext?x(r,this).index(u)>=0:x.find(r,this,null,[u]).length),o[r]&&o.push(i);o.length&&s.push({elem:u,handlers:o})}return n.length>l&&s.push({elem:this,handlers:n.slice(l)}),s},fix:function(e){if(e[x.expando])return e;var t,n,r,i=e.type,o=e,s=this.fixHooks[i];s||(this.fixHooks[i]=s=tt.test(i)?this.mouseHooks:et.test(i)?this.keyHooks:{}),r=s.props?this.props.concat(s.props):this.props,e=new x.Event(o),t=r.length;while(t--)n=r[t],e[n]=o[n];return e.target||(e.target=o.srcElement||a),3===e.target.nodeType&&(e.target=e.target.parentNode),e.metaKey=!!e.metaKey,s.filter?s.filter(e,o):e},props:"altKey bubbles cancelable ctrlKey currentTarget eventPhase metaKey relatedTarget shiftKey target timeStamp view which".split(" "),fixHooks:{},keyHooks:{props:"char charCode key keyCode".split(" "),filter:function(e,t){return null==e.which&&(e.which=null!=t.charCode?t.charCode:t.keyCode),e}},mouseHooks:{props:"button buttons clientX clientY fromElement offsetX offsetY pageX pageY screenX screenY toElement".split(" "),filter:function(e,n){var r,i,o,s=n.button,l=n.fromElement;return null==e.pageX&&null!=n.clientX&&(i=e.target.ownerDocument||a,o=i.documentElement,r=i.body,e.pageX=n.clientX+(o&&o.scrollLeft||r&&r.scrollLeft||0)-(o&&o.clientLeft||r&&r.clientLeft||0),e.pageY=n.clientY+(o&&o.scrollTop||r&&r.scrollTop||0)-(o&&o.clientTop||r&&r.clientTop||0)),!e.relatedTarget&&l&&(e.relatedTarget=l===e.target?n.toElement:l),e.which||s===t||(e.which=1&s?1:2&s?3:4&s?2:0),e}},special:{load:{noBubble:!0},focus:{trigger:function(){if(this!==at()&&this.focus)try{return this.focus(),!1}catch(e){}},delegateType:"focusin"},blur:{trigger:function(){return this===at()&&this.blur?(this.blur(),!1):t},delegateType:"focusout"},click:{trigger:function(){return x.nodeName(this,"input")&&"checkbox"===this.type&&this.click?(this.click(),!1):t},_default:function(e){return x.nodeName(e.target,"a")}},beforeunload:{postDispatch:function(e){e.result!==t&&(e.originalEvent.returnValue=e.result)}}},simulate:function(e,t,n,r){var i=x.extend(new x.Event,n,{type:e,isSimulated:!0,originalEvent:{}});r?x.event.trigger(i,null,t):x.event.dispatch.call(t,i),i.isDefaultPrevented()&&n.preventDefault()}},x.removeEvent=a.removeEventListener?function(e,t,n){e.removeEventListener&&e.removeEventListener(t,n,!1)}:function(e,t,n){var r="on"+t;e.detachEvent&&(typeof e[r]===i&&(e[r]=null),e.detachEvent(r,n))},x.Event=function(e,n){return this instanceof x.Event?(e&&e.type?(this.originalEvent=e,this.type=e.type,this.isDefaultPrevented=e.defaultPrevented||e.returnValue===!1||e.getPreventDefault&&e.getPreventDefault()?it:ot):this.type=e,n&&x.extend(this,n),this.timeStamp=e&&e.timeStamp||x.now(),this[x.expando]=!0,t):new x.Event(e,n)},x.Event.prototype={isDefaultPrevented:ot,isPropagationStopped:ot,isImmediatePropagationStopped:ot,preventDefault:function(){var e=this.originalEvent;this.isDefaultPrevented=it,e&&(e.preventDefault?e.preventDefault():e.returnValue=!1)},stopPropagation:function(){var e=this.originalEvent;this.isPropagationStopped=it,e&&(e.stopPropagation&&e.stopPropagation(),e.cancelBubble=!0)},stopImmediatePropagation:function(){this.isImmediatePropagationStopped=it,this.stopPropagation()}},x.each({mouseenter:"mouseover",mouseleave:"mouseout"},function(e,t){x.event.special[e]={delegateType:t,bindType:t,handle:function(e){var n,r=this,i=e.relatedTarget,o=e.handleObj;return(!i||i!==r&&!x.contains(r,i))&&(e.type=o.origType,n=o.handler.apply(this,arguments),e.type=t),n}}}),x.support.submitBubbles||(x.event.special.submit={setup:function(){return x.nodeName(this,"form")?!1:(x.event.add(this,"click._submit keypress._submit",function(e){var n=e.target,r=x.nodeName(n,"input")||x.nodeName(n,"button")?n.form:t;r&&!x._data(r,"submitBubbles")&&(x.event.add(r,"submit._submit",function(e){e._submit_bubble=!0}),x._data(r,"submitBubbles",!0))}),t)},postDispatch:function(e){e._submit_bubble&&(delete e._submit_bubble,this.parentNode&&!e.isTrigger&&x.event.simulate("submit",this.parentNode,e,!0))},teardown:function(){return x.nodeName(this,"form")?!1:(x.event.remove(this,"._submit"),t)}}),x.support.changeBubbles||(x.event.special.change={setup:function(){return Z.test(this.nodeName)?(("checkbox"===this.type||"radio"===this.type)&&(x.event.add(this,"propertychange._change",function(e){"checked"===e.originalEvent.propertyName&&(this._just_changed=!0)}),x.event.add(this,"click._change",function(e){this._just_changed&&!e.isTrigger&&(this._just_changed=!1),x.event.simulate("change",this,e,!0)})),!1):(x.event.add(this,"beforeactivate._change",function(e){var t=e.target;Z.test(t.nodeName)&&!x._data(t,"changeBubbles")&&(x.event.add(t,"change._change",function(e){!this.parentNode||e.isSimulated||e.isTrigger||x.event.simulate("change",this.parentNode,e,!0)}),x._data(t,"changeBubbles",!0))}),t)},handle:function(e){var n=e.target;return this!==n||e.isSimulated||e.isTrigger||"radio"!==n.type&&"checkbox"!==n.type?e.handleObj.handler.apply(this,arguments):t},teardown:function(){return x.event.remove(this,"._change"),!Z.test(this.nodeName)}}),x.support.focusinBubbles||x.each({focus:"focusin",blur:"focusout"},function(e,t){var n=0,r=function(e){x.event.simulate(t,e.target,x.event.fix(e),!0)};x.event.special[t]={setup:function(){0===n++&&a.addEventListener(e,r,!0)},teardown:function(){0===--n&&a.removeEventListener(e,r,!0)}}}),x.fn.extend({on:function(e,n,r,i,o){var a,s;if("object"==typeof e){"string"!=typeof n&&(r=r||n,n=t);for(a in e)this.on(a,n,r,e[a],o);return this}if(null==r&&null==i?(i=n,r=n=t):null==i&&("string"==typeof n?(i=r,r=t):(i=r,r=n,n=t)),i===!1)i=ot;else if(!i)return this;return 1===o&&(s=i,i=function(e){return x().off(e),s.apply(this,arguments)},i.guid=s.guid||(s.guid=x.guid++)),this.each(function(){x.event.add(this,e,i,r,n)})},one:function(e,t,n,r){return this.on(e,t,n,r,1)},off:function(e,n,r){var i,o;if(e&&e.preventDefault&&e.handleObj)return i=e.handleObj,x(e.delegateTarget).off(i.namespace?i.origType+"."+i.namespace:i.origType,i.selector,i.handler),this;if("object"==typeof e){for(o in e)this.off(o,n,e[o]);return this}return(n===!1||"function"==typeof n)&&(r=n,n=t),r===!1&&(r=ot),this.each(function(){x.event.remove(this,e,r,n)})},trigger:function(e,t){return this.each(function(){x.event.trigger(e,t,this)})},triggerHandler:function(e,n){var r=this[0];return r?x.event.trigger(e,n,r,!0):t}});var st=/^.[^:#\[\.,]*$/,lt=/^(?:parents|prev(?:Until|All))/,ut=x.expr.match.needsContext,ct={children:!0,contents:!0,next:!0,prev:!0};x.fn.extend({find:function(e){var t,n=[],r=this,i=r.length;if("string"!=typeof e)return this.pushStack(x(e).filter(function(){for(t=0;i>t;t++)if(x.contains(r[t],this))return!0}));for(t=0;i>t;t++)x.find(e,r[t],n);return n=this.pushStack(i>1?x.unique(n):n),n.selector=this.selector?this.selector+" "+e:e,n},has:function(e){var t,n=x(e,this),r=n.length;return this.filter(function(){for(t=0;r>t;t++)if(x.contains(this,n[t]))return!0})},not:function(e){return this.pushStack(ft(this,e||[],!0))},filter:function(e){return this.pushStack(ft(this,e||[],!1))},is:function(e){return!!ft(this,"string"==typeof e&&ut.test(e)?x(e):e||[],!1).length},closest:function(e,t){var n,r=0,i=this.length,o=[],a=ut.test(e)||"string"!=typeof e?x(e,t||this.context):0;for(;i>r;r++)for(n=this[r];n&&n!==t;n=n.parentNode)if(11>n.nodeType&&(a?a.index(n)>-1:1===n.nodeType&&x.find.matchesSelector(n,e))){n=o.push(n);break}return this.pushStack(o.length>1?x.unique(o):o)},index:function(e){return e?"string"==typeof e?x.inArray(this[0],x(e)):x.inArray(e.jquery?e[0]:e,this):this[0]&&this[0].parentNode?this.first().prevAll().length:-1},add:function(e,t){var n="string"==typeof e?x(e,t):x.makeArray(e&&e.nodeType?[e]:e),r=x.merge(this.get(),n);return this.pushStack(x.unique(r))},addBack:function(e){return this.add(null==e?this.prevObject:this.prevObject.filter(e))}});function pt(e,t){do e=e[t];while(e&&1!==e.nodeType);return e}x.each({parent:function(e){var t=e.parentNode;return t&&11!==t.nodeType?t:null},parents:function(e){return x.dir(e,"parentNode")},parentsUntil:function(e,t,n){return x.dir(e,"parentNode",n)},next:function(e){return pt(e,"nextSibling")},prev:function(e){return pt(e,"previousSibling")},nextAll:function(e){return x.dir(e,"nextSibling")},prevAll:function(e){return x.dir(e,"previousSibling")},nextUntil:function(e,t,n){return x.dir(e,"nextSibling",n)},prevUntil:function(e,t,n){return x.dir(e,"previousSibling",n)},siblings:function(e){return x.sibling((e.parentNode||{}).firstChild,e)},children:function(e){return x.sibling(e.firstChild)},contents:function(e){return x.nodeName(e,"iframe")?e.contentDocument||e.contentWindow.document:x.merge([],e.childNodes)}},function(e,t){x.fn[e]=function(n,r){var i=x.map(this,t,n);return"Until"!==e.slice(-5)&&(r=n),r&&"string"==typeof r&&(i=x.filter(r,i)),this.length>1&&(ct[e]||(i=x.unique(i)),lt.test(e)&&(i=i.reverse())),this.pushStack(i)}}),x.extend({filter:function(e,t,n){var r=t[0];return n&&(e=":not("+e+")"),1===t.length&&1===r.nodeType?x.find.matchesSelector(r,e)?[r]:[]:x.find.matches(e,x.grep(t,function(e){return 1===e.nodeType}))},dir:function(e,n,r){var i=[],o=e[n];while(o&&9!==o.nodeType&&(r===t||1!==o.nodeType||!x(o).is(r)))1===o.nodeType&&i.push(o),o=o[n];return i},sibling:function(e,t){var n=[];for(;e;e=e.nextSibling)1===e.nodeType&&e!==t&&n.push(e);return n}});function ft(e,t,n){if(x.isFunction(t))return x.grep(e,function(e,r){return!!t.call(e,r,e)!==n});if(t.nodeType)return x.grep(e,function(e){return e===t!==n});if("string"==typeof t){if(st.test(t))return x.filter(t,e,n);t=x.filter(t,e)}return x.grep(e,function(e){return x.inArray(e,t)>=0!==n})}function dt(e){var t=ht.split("|"),n=e.createDocumentFragment();if(n.createElement)while(t.length)n.createElement(t.pop());return n}var ht="abbr|article|aside|audio|bdi|canvas|data|datalist|details|figcaption|figure|footer|header|hgroup|mark|meter|nav|output|progress|section|summary|time|video",gt=/ jQuery\d+="(?:null|\d+)"/g,mt=RegExp("<(?:"+ht+")[\\s/>]","i"),yt=/^\s+/,vt=/<(?!area|br|col|embed|hr|img|input|link|meta|param)(([\w:]+)[^>]*)\/>/gi,bt=/<([\w:]+)/,xt=/\s*$/g,At={option:[1,""],legend:[1,"
","
"],area:[1,"",""],param:[1,"",""],thead:[1,"","
"],tr:[2,"","
"],col:[2,"","
"],td:[3,"","
"],_default:x.support.htmlSerialize?[0,"",""]:[1,"X
","
"]},jt=dt(a),Dt=jt.appendChild(a.createElement("div"));At.optgroup=At.option,At.tbody=At.tfoot=At.colgroup=At.caption=At.thead,At.th=At.td,x.fn.extend({text:function(e){return x.access(this,function(e){return e===t?x.text(this):this.empty().append((this[0]&&this[0].ownerDocument||a).createTextNode(e))},null,e,arguments.length)},append:function(){return this.domManip(arguments,function(e){if(1===this.nodeType||11===this.nodeType||9===this.nodeType){var t=Lt(this,e);t.appendChild(e)}})},prepend:function(){return this.domManip(arguments,function(e){if(1===this.nodeType||11===this.nodeType||9===this.nodeType){var t=Lt(this,e);t.insertBefore(e,t.firstChild)}})},before:function(){return this.domManip(arguments,function(e){this.parentNode&&this.parentNode.insertBefore(e,this)})},after:function(){return this.domManip(arguments,function(e){this.parentNode&&this.parentNode.insertBefore(e,this.nextSibling)})},remove:function(e,t){var n,r=e?x.filter(e,this):this,i=0;for(;null!=(n=r[i]);i++)t||1!==n.nodeType||x.cleanData(Ft(n)),n.parentNode&&(t&&x.contains(n.ownerDocument,n)&&_t(Ft(n,"script")),n.parentNode.removeChild(n));return this},empty:function(){var e,t=0;for(;null!=(e=this[t]);t++){1===e.nodeType&&x.cleanData(Ft(e,!1));while(e.firstChild)e.removeChild(e.firstChild);e.options&&x.nodeName(e,"select")&&(e.options.length=0)}return this},clone:function(e,t){return e=null==e?!1:e,t=null==t?e:t,this.map(function(){return x.clone(this,e,t)})},html:function(e){return x.access(this,function(e){var n=this[0]||{},r=0,i=this.length;if(e===t)return 1===n.nodeType?n.innerHTML.replace(gt,""):t;if(!("string"!=typeof e||Tt.test(e)||!x.support.htmlSerialize&&mt.test(e)||!x.support.leadingWhitespace&&yt.test(e)||At[(bt.exec(e)||["",""])[1].toLowerCase()])){e=e.replace(vt,"<$1>");try{for(;i>r;r++)n=this[r]||{},1===n.nodeType&&(x.cleanData(Ft(n,!1)),n.innerHTML=e);n=0}catch(o){}}n&&this.empty().append(e)},null,e,arguments.length)},replaceWith:function(){var e=x.map(this,function(e){return[e.nextSibling,e.parentNode]}),t=0;return this.domManip(arguments,function(n){var r=e[t++],i=e[t++];i&&(r&&r.parentNode!==i&&(r=this.nextSibling),x(this).remove(),i.insertBefore(n,r))},!0),t?this:this.remove()},detach:function(e){return this.remove(e,!0)},domManip:function(e,t,n){e=d.apply([],e);var r,i,o,a,s,l,u=0,c=this.length,p=this,f=c-1,h=e[0],g=x.isFunction(h);if(g||!(1>=c||"string"!=typeof h||x.support.checkClone)&&Nt.test(h))return this.each(function(r){var i=p.eq(r);g&&(e[0]=h.call(this,r,i.html())),i.domManip(e,t,n)});if(c&&(l=x.buildFragment(e,this[0].ownerDocument,!1,!n&&this),r=l.firstChild,1===l.childNodes.length&&(l=r),r)){for(a=x.map(Ft(l,"script"),Ht),o=a.length;c>u;u++)i=l,u!==f&&(i=x.clone(i,!0,!0),o&&x.merge(a,Ft(i,"script"))),t.call(this[u],i,u);if(o)for(s=a[a.length-1].ownerDocument,x.map(a,qt),u=0;o>u;u++)i=a[u],kt.test(i.type||"")&&!x._data(i,"globalEval")&&x.contains(s,i)&&(i.src?x._evalUrl(i.src):x.globalEval((i.text||i.textContent||i.innerHTML||"").replace(St,"")));l=r=null}return this}});function Lt(e,t){return x.nodeName(e,"table")&&x.nodeName(1===t.nodeType?t:t.firstChild,"tr")?e.getElementsByTagName("tbody")[0]||e.appendChild(e.ownerDocument.createElement("tbody")):e}function Ht(e){return e.type=(null!==x.find.attr(e,"type"))+"/"+e.type,e}function qt(e){var t=Et.exec(e.type);return t?e.type=t[1]:e.removeAttribute("type"),e}function _t(e,t){var n,r=0;for(;null!=(n=e[r]);r++)x._data(n,"globalEval",!t||x._data(t[r],"globalEval"))}function Mt(e,t){if(1===t.nodeType&&x.hasData(e)){var n,r,i,o=x._data(e),a=x._data(t,o),s=o.events;if(s){delete a.handle,a.events={};for(n in s)for(r=0,i=s[n].length;i>r;r++)x.event.add(t,n,s[n][r])}a.data&&(a.data=x.extend({},a.data))}}function Ot(e,t){var n,r,i;if(1===t.nodeType){if(n=t.nodeName.toLowerCase(),!x.support.noCloneEvent&&t[x.expando]){i=x._data(t);for(r in i.events)x.removeEvent(t,r,i.handle);t.removeAttribute(x.expando)}"script"===n&&t.text!==e.text?(Ht(t).text=e.text,qt(t)):"object"===n?(t.parentNode&&(t.outerHTML=e.outerHTML),x.support.html5Clone&&e.innerHTML&&!x.trim(t.innerHTML)&&(t.innerHTML=e.innerHTML)):"input"===n&&Ct.test(e.type)?(t.defaultChecked=t.checked=e.checked,t.value!==e.value&&(t.value=e.value)):"option"===n?t.defaultSelected=t.selected=e.defaultSelected:("input"===n||"textarea"===n)&&(t.defaultValue=e.defaultValue)}}x.each({appendTo:"append",prependTo:"prepend",insertBefore:"before",insertAfter:"after",replaceAll:"replaceWith"},function(e,t){x.fn[e]=function(e){var n,r=0,i=[],o=x(e),a=o.length-1;for(;a>=r;r++)n=r===a?this:this.clone(!0),x(o[r])[t](n),h.apply(i,n.get());return this.pushStack(i)}});function Ft(e,n){var r,o,a=0,s=typeof e.getElementsByTagName!==i?e.getElementsByTagName(n||"*"):typeof e.querySelectorAll!==i?e.querySelectorAll(n||"*"):t;if(!s)for(s=[],r=e.childNodes||e;null!=(o=r[a]);a++)!n||x.nodeName(o,n)?s.push(o):x.merge(s,Ft(o,n));return n===t||n&&x.nodeName(e,n)?x.merge([e],s):s}function Bt(e){Ct.test(e.type)&&(e.defaultChecked=e.checked)}x.extend({clone:function(e,t,n){var r,i,o,a,s,l=x.contains(e.ownerDocument,e);if(x.support.html5Clone||x.isXMLDoc(e)||!mt.test("<"+e.nodeName+">")?o=e.cloneNode(!0):(Dt.innerHTML=e.outerHTML,Dt.removeChild(o=Dt.firstChild)),!(x.support.noCloneEvent&&x.support.noCloneChecked||1!==e.nodeType&&11!==e.nodeType||x.isXMLDoc(e)))for(r=Ft(o),s=Ft(e),a=0;null!=(i=s[a]);++a)r[a]&&Ot(i,r[a]);if(t)if(n)for(s=s||Ft(e),r=r||Ft(o),a=0;null!=(i=s[a]);a++)Mt(i,r[a]);else Mt(e,o);return r=Ft(o,"script"),r.length>0&&_t(r,!l&&Ft(e,"script")),r=s=i=null,o},buildFragment:function(e,t,n,r){var i,o,a,s,l,u,c,p=e.length,f=dt(t),d=[],h=0;for(;p>h;h++)if(o=e[h],o||0===o)if("object"===x.type(o))x.merge(d,o.nodeType?[o]:o);else if(wt.test(o)){s=s||f.appendChild(t.createElement("div")),l=(bt.exec(o)||["",""])[1].toLowerCase(),c=At[l]||At._default,s.innerHTML=c[1]+o.replace(vt,"<$1>")+c[2],i=c[0];while(i--)s=s.lastChild;if(!x.support.leadingWhitespace&&yt.test(o)&&d.push(t.createTextNode(yt.exec(o)[0])),!x.support.tbody){o="table"!==l||xt.test(o)?""!==c[1]||xt.test(o)?0:s:s.firstChild,i=o&&o.childNodes.length;while(i--)x.nodeName(u=o.childNodes[i],"tbody")&&!u.childNodes.length&&o.removeChild(u)}x.merge(d,s.childNodes),s.textContent="";while(s.firstChild)s.removeChild(s.firstChild);s=f.lastChild}else d.push(t.createTextNode(o));s&&f.removeChild(s),x.support.appendChecked||x.grep(Ft(d,"input"),Bt),h=0;while(o=d[h++])if((!r||-1===x.inArray(o,r))&&(a=x.contains(o.ownerDocument,o),s=Ft(f.appendChild(o),"script"),a&&_t(s),n)){i=0;while(o=s[i++])kt.test(o.type||"")&&n.push(o)}return s=null,f},cleanData:function(e,t){var n,r,o,a,s=0,l=x.expando,u=x.cache,c=x.support.deleteExpando,f=x.event.special;for(;null!=(n=e[s]);s++)if((t||x.acceptData(n))&&(o=n[l],a=o&&u[o])){if(a.events)for(r in a.events)f[r]?x.event.remove(n,r):x.removeEvent(n,r,a.handle); -u[o]&&(delete u[o],c?delete n[l]:typeof n.removeAttribute!==i?n.removeAttribute(l):n[l]=null,p.push(o))}},_evalUrl:function(e){return x.ajax({url:e,type:"GET",dataType:"script",async:!1,global:!1,"throws":!0})}}),x.fn.extend({wrapAll:function(e){if(x.isFunction(e))return this.each(function(t){x(this).wrapAll(e.call(this,t))});if(this[0]){var t=x(e,this[0].ownerDocument).eq(0).clone(!0);this[0].parentNode&&t.insertBefore(this[0]),t.map(function(){var e=this;while(e.firstChild&&1===e.firstChild.nodeType)e=e.firstChild;return e}).append(this)}return this},wrapInner:function(e){return x.isFunction(e)?this.each(function(t){x(this).wrapInner(e.call(this,t))}):this.each(function(){var t=x(this),n=t.contents();n.length?n.wrapAll(e):t.append(e)})},wrap:function(e){var t=x.isFunction(e);return this.each(function(n){x(this).wrapAll(t?e.call(this,n):e)})},unwrap:function(){return this.parent().each(function(){x.nodeName(this,"body")||x(this).replaceWith(this.childNodes)}).end()}});var Pt,Rt,Wt,$t=/alpha\([^)]*\)/i,It=/opacity\s*=\s*([^)]*)/,zt=/^(top|right|bottom|left)$/,Xt=/^(none|table(?!-c[ea]).+)/,Ut=/^margin/,Vt=RegExp("^("+w+")(.*)$","i"),Yt=RegExp("^("+w+")(?!px)[a-z%]+$","i"),Jt=RegExp("^([+-])=("+w+")","i"),Gt={BODY:"block"},Qt={position:"absolute",visibility:"hidden",display:"block"},Kt={letterSpacing:0,fontWeight:400},Zt=["Top","Right","Bottom","Left"],en=["Webkit","O","Moz","ms"];function tn(e,t){if(t in e)return t;var n=t.charAt(0).toUpperCase()+t.slice(1),r=t,i=en.length;while(i--)if(t=en[i]+n,t in e)return t;return r}function nn(e,t){return e=t||e,"none"===x.css(e,"display")||!x.contains(e.ownerDocument,e)}function rn(e,t){var n,r,i,o=[],a=0,s=e.length;for(;s>a;a++)r=e[a],r.style&&(o[a]=x._data(r,"olddisplay"),n=r.style.display,t?(o[a]||"none"!==n||(r.style.display=""),""===r.style.display&&nn(r)&&(o[a]=x._data(r,"olddisplay",ln(r.nodeName)))):o[a]||(i=nn(r),(n&&"none"!==n||!i)&&x._data(r,"olddisplay",i?n:x.css(r,"display"))));for(a=0;s>a;a++)r=e[a],r.style&&(t&&"none"!==r.style.display&&""!==r.style.display||(r.style.display=t?o[a]||"":"none"));return e}x.fn.extend({css:function(e,n){return x.access(this,function(e,n,r){var i,o,a={},s=0;if(x.isArray(n)){for(o=Rt(e),i=n.length;i>s;s++)a[n[s]]=x.css(e,n[s],!1,o);return a}return r!==t?x.style(e,n,r):x.css(e,n)},e,n,arguments.length>1)},show:function(){return rn(this,!0)},hide:function(){return rn(this)},toggle:function(e){return"boolean"==typeof e?e?this.show():this.hide():this.each(function(){nn(this)?x(this).show():x(this).hide()})}}),x.extend({cssHooks:{opacity:{get:function(e,t){if(t){var n=Wt(e,"opacity");return""===n?"1":n}}}},cssNumber:{columnCount:!0,fillOpacity:!0,fontWeight:!0,lineHeight:!0,opacity:!0,order:!0,orphans:!0,widows:!0,zIndex:!0,zoom:!0},cssProps:{"float":x.support.cssFloat?"cssFloat":"styleFloat"},style:function(e,n,r,i){if(e&&3!==e.nodeType&&8!==e.nodeType&&e.style){var o,a,s,l=x.camelCase(n),u=e.style;if(n=x.cssProps[l]||(x.cssProps[l]=tn(u,l)),s=x.cssHooks[n]||x.cssHooks[l],r===t)return s&&"get"in s&&(o=s.get(e,!1,i))!==t?o:u[n];if(a=typeof r,"string"===a&&(o=Jt.exec(r))&&(r=(o[1]+1)*o[2]+parseFloat(x.css(e,n)),a="number"),!(null==r||"number"===a&&isNaN(r)||("number"!==a||x.cssNumber[l]||(r+="px"),x.support.clearCloneStyle||""!==r||0!==n.indexOf("background")||(u[n]="inherit"),s&&"set"in s&&(r=s.set(e,r,i))===t)))try{u[n]=r}catch(c){}}},css:function(e,n,r,i){var o,a,s,l=x.camelCase(n);return n=x.cssProps[l]||(x.cssProps[l]=tn(e.style,l)),s=x.cssHooks[n]||x.cssHooks[l],s&&"get"in s&&(a=s.get(e,!0,r)),a===t&&(a=Wt(e,n,i)),"normal"===a&&n in Kt&&(a=Kt[n]),""===r||r?(o=parseFloat(a),r===!0||x.isNumeric(o)?o||0:a):a}}),e.getComputedStyle?(Rt=function(t){return e.getComputedStyle(t,null)},Wt=function(e,n,r){var i,o,a,s=r||Rt(e),l=s?s.getPropertyValue(n)||s[n]:t,u=e.style;return s&&(""!==l||x.contains(e.ownerDocument,e)||(l=x.style(e,n)),Yt.test(l)&&Ut.test(n)&&(i=u.width,o=u.minWidth,a=u.maxWidth,u.minWidth=u.maxWidth=u.width=l,l=s.width,u.width=i,u.minWidth=o,u.maxWidth=a)),l}):a.documentElement.currentStyle&&(Rt=function(e){return e.currentStyle},Wt=function(e,n,r){var i,o,a,s=r||Rt(e),l=s?s[n]:t,u=e.style;return null==l&&u&&u[n]&&(l=u[n]),Yt.test(l)&&!zt.test(n)&&(i=u.left,o=e.runtimeStyle,a=o&&o.left,a&&(o.left=e.currentStyle.left),u.left="fontSize"===n?"1em":l,l=u.pixelLeft+"px",u.left=i,a&&(o.left=a)),""===l?"auto":l});function on(e,t,n){var r=Vt.exec(t);return r?Math.max(0,r[1]-(n||0))+(r[2]||"px"):t}function an(e,t,n,r,i){var o=n===(r?"border":"content")?4:"width"===t?1:0,a=0;for(;4>o;o+=2)"margin"===n&&(a+=x.css(e,n+Zt[o],!0,i)),r?("content"===n&&(a-=x.css(e,"padding"+Zt[o],!0,i)),"margin"!==n&&(a-=x.css(e,"border"+Zt[o]+"Width",!0,i))):(a+=x.css(e,"padding"+Zt[o],!0,i),"padding"!==n&&(a+=x.css(e,"border"+Zt[o]+"Width",!0,i)));return a}function sn(e,t,n){var r=!0,i="width"===t?e.offsetWidth:e.offsetHeight,o=Rt(e),a=x.support.boxSizing&&"border-box"===x.css(e,"boxSizing",!1,o);if(0>=i||null==i){if(i=Wt(e,t,o),(0>i||null==i)&&(i=e.style[t]),Yt.test(i))return i;r=a&&(x.support.boxSizingReliable||i===e.style[t]),i=parseFloat(i)||0}return i+an(e,t,n||(a?"border":"content"),r,o)+"px"}function ln(e){var t=a,n=Gt[e];return n||(n=un(e,t),"none"!==n&&n||(Pt=(Pt||x("