diff --git a/.htaccess b/.htaccess index 6c370407..c7c01254 100755 --- a/.htaccess +++ b/.htaccess @@ -6,6 +6,13 @@ Order allow,deny + + RewriteEngine On + # Protect hidden directory from vulnerability scanner + RewriteRule (^|/)\.([^/]+)(/|$) - [L,F] + RewriteRule (^|/)([^/]+)~(/|$) - [L,F] + + # Don't show directory listings for URLs which map to a directory. Options -Indexes diff --git a/admin/admin_template/akasia-dz/index_template.inc.php b/admin/admin_template/akasia-dz/index_template.inc.php index 3ee56264..4c2bb8dc 100644 --- a/admin/admin_template/akasia-dz/index_template.inc.php +++ b/admin/admin_template/akasia-dz/index_template.inc.php @@ -86,7 +86,15 @@
- Photo <?php echo $_SESSION['realname']?> + + Photo <?php echo $_SESSION['realname'] ?>

diff --git a/admin/admin_template/akasia/index_template.inc.php b/admin/admin_template/akasia/index_template.inc.php index 8d3b7d77..cda818f6 100755 --- a/admin/admin_template/akasia/index_template.inc.php +++ b/admin/admin_template/akasia/index_template.inc.php @@ -85,7 +85,15 @@
- Photo <?php echo $_SESSION['realname']?> + + Photo <?php echo $_SESSION['realname'] ?>

diff --git a/admin/admin_template/default/index_template.inc.php b/admin/admin_template/default/index_template.inc.php index 99691d67..c502c8e4 100755 --- a/admin/admin_template/default/index_template.inc.php +++ b/admin/admin_template/default/index_template.inc.php @@ -34,8 +34,8 @@ - + @@ -64,7 +64,15 @@
@@ -294,4 +294,4 @@ let fileName = $(this).val().replace(/\\/g, '/').replace(/.*\//, ''); $(this).parent('.custom-file').find('.custom-file-label').text(fileName); }); - \ No newline at end of file + diff --git a/admin/modules/bibliography/index.php b/admin/modules/bibliography/index.php index f9f80b8b..a264df64 100755 --- a/admin/modules/bibliography/index.php +++ b/admin/modules/bibliography/index.php @@ -226,8 +226,15 @@ function getimagesizefromstring($string_data) $image_upload->setAllowableFormat($sysconf['allowed_images']); $image_upload->setMaxSize($sysconf['max_image_upload'] * 1024); $image_upload->setUploadDir(IMGBS . 'docs'); + + $img_title = $data['title'].'_'.date("YmdHis"); + if(strlen($data['title']) > 70){ + $img_title = substr($data['title'], 0, 70).'_'.date("YmdHis"); + } + + $new_filename = strtolower('cover_'. preg_replace("/[^a-zA-Z0-9]+/", "-", $img_title)); // upload the file and change all space characters to underscore - $img_upload_status = $image_upload->doUpload('image', preg_replace('@\s+@i', '_', $_FILES['image']['name'])); + $img_upload_status = $image_upload->doUpload('image', $new_filename); if ($img_upload_status == UPLOAD_SUCCESS) { $data['image'] = $dbs->escape_string($image_upload->new_filename); // write log @@ -235,8 +242,9 @@ function getimagesizefromstring($string_data) utility::jsToastr('Bibliography', __('Image Uploaded Successfully'), 'success'); } else { // write log + $data['image'] = NULL; utility::writeLogs($dbs, 'staff', $_SESSION['uid'], 'bibliography', 'ERROR : ' . $_SESSION['realname'] . ' FAILED TO upload image file ' . $image_upload->new_filename . ', with error (' . $image_upload->error . ')'); - utility::jsToastr('Bibliography', __('Image Uploaded Failed'), 'error'); + utility::jsToastr('Bibliography', __('Image Uploaded Failed').'
'.$image_upload->error, 'error'); } } else if (!empty($_POST['base64picstring'])) { list($filedata, $filedom) = explode('#image/type#', $_POST['base64picstring']); diff --git a/admin/modules/bibliography/item_import.php b/admin/modules/bibliography/item_import.php index 42a12552..f0531f3a 100755 --- a/admin/modules/bibliography/item_import.php +++ b/admin/modules/bibliography/item_import.php @@ -133,30 +133,39 @@ $item_status = utility::getID($dbs, 'mst_item_status', 'item_status_id', 'item_status_name', $field[9], $stat_id_cache); $item_status = $item_status?'\''.$item_status.'\'':'NULL'; $site = $field[10]?'\''.$field[10].'\'':'NULL'; - $source = $field[11]?'\''.$field[11].'\'':'NULL'; + $source = $field[11]?'\''.$field[11].'\'':'0'; $invoice = $field[12]?'\''.$field[12].'\'':'NULL'; $price = $field[13]?'\''.$field[13].'\'':'NULL'; $price_currency = $field[14]?'\''.$field[14].'\'':'NULL'; $invoice_date = $field[15]?'\''.$field[15].'\'':'NULL'; - $input_date = '\''.$field[16].'\''; - $last_update = '\''.$field[17].'\''; - - // sql insert string - $sql_str = "INSERT INTO item (item_code, call_number, coll_type_id, - inventory_code, received_date, supplier_id, - order_no, location_id, order_date, item_status_id, site, - source, invoice, price, price_currency, invoice_date, - input_date, last_update) - VALUES ($item_code, $call_number, $coll_type, - $inventory_code, $received_date, $supplier, - $order_no, $location, $order_date, $item_status, $site, - $source, $invoice, $price, $price_currency, $invoice_date, - $input_date, $last_update)"; + $input_date = $field[16]?'\''.$field[16].'\'':'\''.date('Y-m-d H:i:s').'\''; + $last_update = $field[17]?'\''.$field[17].'\'':'\''.date('Y-m-d H:i:s').'\''; + $title = $field[18]; // first field is header if (isset($_POST['header']) && $n < 1) { $n++; + continue; } else { + + // get biblio_id + $b_q = $dbs->query(sprintf("select biblio_id from biblio where title = '%s'", $title)); + if($b_q->num_rows < 1) continue; + $b_d = $b_q->fetch_row(); + $biblio_id = $b_d[0]; + + // sql insert string + $sql_str = "INSERT INTO item (biblio_id, item_code, call_number, coll_type_id, + inventory_code, received_date, supplier_id, + order_no, location_id, order_date, item_status_id, site, + source, invoice, price, price_currency, invoice_date, + input_date, last_update) + VALUES ($biblio_id, $item_code, $call_number, $coll_type, + $inventory_code, $received_date, $supplier, + $order_no, $location, $order_date, $item_status, $site, + $source, $invoice, $price, $price_currency, $invoice_date, + $input_date, $last_update)"; + // send query // die($sql_str); $dbs->query($sql_str); diff --git a/admin/modules/bibliography/marcexport.php b/admin/modules/bibliography/marcexport.php index 8fbf72cb..7729472e 100644 --- a/admin/modules/bibliography/marcexport.php +++ b/admin/modules/bibliography/marcexport.php @@ -216,14 +216,14 @@ require LIB.'biblio_list_index.inc.php'; } // table spec - $table_spec = 'search_biblio'; + $table_spec = 'search_biblio AS `index`'; $datagrid->setSQLColumn('biblio_id', 'title AS \''.__('Title').'\'', 'author AS \''.__('Author').'\''); } else { require LIB.'biblio_list.inc.php'; // table spec - $table_spec = 'search_biblio'; + $table_spec = 'search_biblio AS `index`'; $datagrid->setSQLColumn('biblio_id', 'title AS \''.__('Title').'\'', 'author AS \''.__('Author').'\''); diff --git a/admin/modules/bibliography/pop_attach.php b/admin/modules/bibliography/pop_attach.php index 8cb9a2fb..487b6913 100755 --- a/admin/modules/bibliography/pop_attach.php +++ b/admin/modules/bibliography/pop_attach.php @@ -88,6 +88,8 @@ $fdata['file_url'] = $dbs->escape_string($url); $fdata['file_dir'] = $dbs->escape_string($file_dir); $fdata['file_desc'] = $dbs->escape_string(trim(strip_tags($_POST['fileDesc']))); + if(isset($_POST['fileKey']) && trim($_POST['fileKey']) !== '') + $fdata['file_key'] = $dbs->escape_string(trim(strip_tags($_POST['fileKey']))); $fdata['mime_type'] = $sysconf['mimetype'][$file_ext]; $fdata['input_date'] = date('Y-m-d H:i:s'); $fdata['last_update'] = $fdata['input_date']; @@ -110,6 +112,8 @@ $fdata['file_url'] = $dbs->escape_string($fdata['file_name']); $fdata['file_dir'] = 'literal{NULL}'; $fdata['file_desc'] = $dbs->escape_string(trim(strip_tags($_POST['fileDesc']))); + if(isset($_POST['fileKey']) && trim($_POST['fileKey']) !== '') + $fdata['file_key'] = $dbs->escape_string(trim(strip_tags($_POST['fileKey']))); $fdata['mime_type'] = 'text/uri-list'; $fdata['input_date'] = date('Y-m-d H:i:s'); $fdata['last_update'] = $fdata['input_date']; @@ -144,7 +148,10 @@ // file biblio access update $update1 = $sql_op->update('biblio_attachment', array('access_type' => $data['access_type'], 'access_limit' => $data['access_limit'], 'placement' => $data['placement']), 'biblio_id='.$updateBiblioID.' AND file_id='.$fileID); // file description update - $update2 = $sql_op->update('files', array('file_title' => $title, 'file_url' => $url, 'file_desc' => $dbs->escape_string(trim($_POST['fileDesc']))), 'file_id='.$fileID); + $file_desc_update = array('file_title' => $title, 'file_url' => $url, 'file_desc' => $dbs->escape_string(trim($_POST['fileDesc']))); + if(isset($_POST['fileKey'])) + $file_desc_update['file_key'] = $dbs->escape_string(trim(strip_tags($_POST['fileKey']))); + $update2 = $sql_op->update('files', $file_desc_update, 'file_id='.$fileID); if ($update1) { utility::jsToastr('File Attachment', __('File Attachment data updated!'), 'success'); echo ''; + $xlsquery = "SELECT i.item_code AS '" . __('Item Code') . "', + b.title AS '" . __('Title') . "', + ct.coll_type_name AS '" . __('Collection Type') . "', + i.item_status_id AS '" . __('Item Status') . "', + b.call_number AS '" . __('Call Number') . "' FROM " . + $table_spec . " WHERE " . $criteria; + // echo $xlsquery; + unset($_SESSION['xlsdata']); + $_SESSION['xlsquery'] = $xlsquery; + $_SESSION['tblout'] = "title_list_item"; + $content = ob_get_clean(); // include the page template - require SB.'/admin/'.$sysconf['admin_template']['dir'].'/printed_page_tpl.php'; + require SB . '/admin/' . $sysconf['admin_template']['dir'] . '/printed_page_tpl.php'; } diff --git a/admin/modules/system/app_user.php b/admin/modules/system/app_user.php index 6ff5be94..ab99f29d 100755 --- a/admin/modules/system/app_user.php +++ b/admin/modules/system/app_user.php @@ -74,6 +74,8 @@ function getUserType($obj_db, $array_data, $col) { if ($query_image->num_rows > 0) { $_delete = $dbs->query(sprintf('UPDATE user SET user_image=NULL WHERE user_id=%d', $_POST['uimg'])); if ($_delete) { + // Change upict + $_SESSION['upict'] = 'person.png'; $postImage = stripslashes($_POST['img']); $postImage = str_replace('/', '', $postImage); @unlink(sprintf(IMGBS.'persons/%s', $postImage)); @@ -177,6 +179,8 @@ function getUserType($obj_db, $array_data, $col) { // upload status alert if (isset($upload_status)) { if ($upload_status == UPLOAD_SUCCESS) { + // Change upict + $_SESSION['upict'] = $data['user_image']; // write log utility::writeLogs($dbs, 'staff', $_SESSION['uid'], 'system/user', $_SESSION['realname'].' upload image file '.$upload->new_filename, 'User image', 'Upload'); utility::jsAlert(__('Image Uploaded Successfully')); @@ -200,6 +204,8 @@ function getUserType($obj_db, $array_data, $col) { // upload status alert if (isset($upload_status)) { if ($upload_status == UPLOAD_SUCCESS) { + // Change upict + $_SESSION['upict'] = $data['user_image']; // write log utility::writeLogs($dbs, 'staff', $_SESSION['uid'], 'system/user', $_SESSION['realname'].' upload image file '.$upload->new_filename, 'User image', 'Upload'); utility::jsAlert(__('Image Uploaded Successfully')); diff --git a/admin/modules/system/backup.php b/admin/modules/system/backup.php index c7e6fc09..0741622e 100755 --- a/admin/modules/system/backup.php +++ b/admin/modules/system/backup.php @@ -143,23 +143,15 @@ $table_spec = 'backup_log AS bl LEFT JOIN user AS u ON bl.user_id=u.user_id'; // create datagrid $datagrid = new simbio_datagrid(); -if ($can_read AND $can_write) { - $datagrid->setSQLColumn('bl.backup_log_id', - 'u.realname AS \''.__('Backup Executor').'\'', - 'bl.backup_time AS \''.__('Backup Time').'\'', - 'bl.backup_file AS \''.__('Backup File Location').'\'', - 'bl.backup_file AS \''.__('File Size').'\''); - $datagrid->setSQLorder('backup_time DESC'); - $datagrid->modifyColumnContent(4, 'callback{showFileSize}'); -}else{ - $datagrid->setSQLColumn( - 'u.realname AS \''.__('Backup Executor').'\'', +$datagrid->setSQLColumn('bl.backup_log_id', + 'u.realname AS \''.__('Backup Executor').'\'', 'bl.backup_time AS \''.__('Backup Time').'\'', 'bl.backup_file AS \''.__('Backup File Location').'\'', - 'bl.backup_file AS \''.__('File Size').'\''); - $datagrid->setSQLorder('backup_time DESC'); - $datagrid->modifyColumnContent(3, 'callback{showFileSize}'); -} + 'bl.backup_file AS \''.__('File Size').'\''); +$datagrid->setSQLorder('backup_time DESC'); +$datagrid->modifyColumnContent(4, 'callback{showFileSize}'); +if (!$can_write) $datagrid->invisible_fields = [0]; + // is there any search if (isset($_GET['keywords']) AND $_GET['keywords']) { $keywords = $dbs->escape_string($_GET['keywords']); diff --git a/admin/modules/system/biblio_indexer.inc.php b/admin/modules/system/biblio_indexer.inc.php index 24fc0b27..138bafe7 100755 --- a/admin/modules/system/biblio_indexer.inc.php +++ b/admin/modules/system/biblio_indexer.inc.php @@ -139,7 +139,7 @@ public function makeIndex($int_biblio_id) { $data['publish_place'] = $this->obj_db->escape_string($rb_id['publish_place']); $data['isbn_issn'] = $this->obj_db->escape_string($rb_id['isbn_issn']); $data['language'] = $this->obj_db->escape_string($rb_id['language']); - $data['publish_year'] = $rb_id['publish_year']; + $data['publish_year'] = $this->obj_db->escape_string($rb_id['publish_year']); $data['classification'] = $this->obj_db->escape_string($rb_id['classification']); $data['spec_detail_info'] = $this->obj_db->escape_string($rb_id['spec_detail_info']); $data['call_number'] = $this->obj_db->escape_string($rb_id['call_number']); diff --git a/admin/modules/system/envinfo.php b/admin/modules/system/envinfo.php index abd4e1a1..54b79058 100644 --- a/admin/modules/system/envinfo.php +++ b/admin/modules/system/envinfo.php @@ -47,6 +47,7 @@ // require SIMBIO.'simbio_DB/simbio_dbop.inc.php'; $environment = array( + array('title' => __('SLiMS Environment Mode'), 'desc' => ucfirst(ENVIRONMENT)), array('title' => __('SLiMS Version'), 'desc' => SENAYAN_VERSION_TAG), array('title' => __('Operating System'), 'desc' => php_uname('a')), array('title' => __('OS Architecture'), 'desc' => php_uname('m').' '.(8 * PHP_INT_SIZE).' bit'), diff --git a/admin/modules/system/envsetting.php b/admin/modules/system/envsetting.php new file mode 100644 index 00000000..41b24ce1 --- /dev/null +++ b/admin/modules/system/envsetting.php @@ -0,0 +1,145 @@ +setTimeout(() => {parent.$(\'#mainContent\').simbioAJAX(\'' . $_SERVER['PHP_SELF'] . '\')}, 5000)'; + // utility::jsAlert(json_encode($write)); + exit; +} + +?> + +
+
+
+

+
+
+ +
+
+
+ +submit_button_attr = 'name="saveData" value="'.__('Save Settings').'" class="btn btn-default"'; + +// form table attributes +$form->table_attr = 'id="dataList" class="s-table table"'; +$form->table_header_attr = 'class="alterCell font-weight-bold"'; +$form->table_content_attr = 'class="alterCell2"'; + +// Your Environment +if ($BasedIp) +{ + $thisEnv = ucfirst((!in_array(getCurrentIp(), $RangeIp) ? $Environment : $ConditionEnvironment)); + $HTML = <<{$thisEnv} + HTML; + $form->addAnything('Your Environment Mode', $HTML); + + $Environment = $ConditionEnvironment; +} + +// Environment List +$EnvOptions = [ + [1, __('Production')], + [0, __('Development')] + ]; +$form->addSelectList('env', __('System Environment Mode'), $EnvOptions, ( $Environment == 'production' ? 1 : 0 ) ,'class="form-control col-3"'); +$BasedIpOptions = [ + [0, __('Disable')], + [1, __('Enable')] +]; +$form->addSelectList('basedIp', __('Environment for some IP?'), $BasedIpOptions, ( $BasedIp ? 1 : 0 ) ,'class="form-control col-3"'); +$form->addTextField('textarea', 'rangeIp', __('Range Ip wil be impacted with Environment. Example : 10.120.33.40;20.100.34.10. '), implode(';', $RangeIp), 'style="margin-top: 0px; margin-bottom: 0px; height: 149px;" class="form-control" placeholder="Leave it empty, if you want to set environment to impact for all IP"'); +// print out the object +echo $form->printOut(); \ No newline at end of file diff --git a/admin/modules/system/holiday.php b/admin/modules/system/holiday.php index 80873180..822cdc74 100755 --- a/admin/modules/system/holiday.php +++ b/admin/modules/system/holiday.php @@ -55,12 +55,12 @@ // check form validity $holDesc = trim($dbs->escape_string(strip_tags($_POST['holDesc']))); if (empty($holDesc)) { - utility::jsAlert(__('Holiday description can\'t be empty!')); + utility::jsToastr(__('Holiday Settings'),__('Holiday description can\'t be empty!'),'warning'); exit(); } else { $data['holiday_date'] = trim($_POST['holDate']); // remove extra whitespace if(!preg_match('@^[0-9]{4}-[0-9]{2}-[0-9]{2}$@', $data['holiday_date'])) { - utility::jsAlert(__('Holiday Date Start must have the format YYYY-MM-DD!')); + utility::jsToastr(__('Holiday Settings'),__('Holiday Date Start must have the format YYYY-MM-DD!'),'warning'); exit(); } $holiday_start_date = $data['holiday_date']; @@ -75,28 +75,28 @@ $updateRecordID = (integer)$_POST['updateRecordID']; if ($sql_op->update('holiday', $data, 'holiday_id='.$updateRecordID)) { utility::writeLogs($dbs, 'staff', $_SESSION['uid'], 'System', $_SESSION['realname'].' update holiday date for '.$data['description'], 'Holiday', 'Update'); - utility::jsAlert(__('Holiday Data Successfully updated')); + utility::jsToastr(__('Holiday Settings'),__('Holiday Data Successfully updated'),'success'); // update holiday_dayname session $_SESSION['holiday_date'][$data['holiday_date']] = $data['holiday_date']; echo ''; exit(); } else { utility::writeLogs($dbs, 'staff', $_SESSION['uid'], 'System', $_SESSION['realname'].' failed update holiday data for '.$data['description'], 'Holiday', 'Fail'); - utility::jsAlert(__('Holiday FAILED to update. Please Contact System Administrator')."\n".$sql_op->error); + utility::jsToastr(__('Holiday Settings'),__('Holiday FAILED to update. Please Contact System Administrator')."\n".$sql_op->error,'error'); } } else { /* INSERT RECORD MODE */ // insert the data if ($sql_op->insert('holiday', $data)) { utility::writeLogs($dbs, 'staff', $_SESSION['uid'], 'System', $_SESSION['realname'].' add holiday date for '.$data['description'], 'Holiday', 'Add'); - utility::jsAlert(__('New Holiday Successfully Saved')); + utility::jsToastr(__('Holiday Settings'),__('New Holiday Successfully Saved'),'success'); // update holiday_dayname session $_SESSION['holiday_date'][$data['holiday_date']] = $data['holiday_date']; // date range insert if (!empty($_POST['holDateEnd'])) { $holiday_end_date = trim($_POST['holDateEnd']); // remove extra whitespace if(!preg_match('@^[0-9]{4}-[0-9]{2}-[0-9]{2}$@', $holiday_end_date)) { - utility::jsAlert(__('Holiday Date End must have the format YYYY-MM-DD if it is not empty!')); + utility::jsToastr(__('Holiday Settings'),__('Holiday Date End must have the format YYYY-MM-DD if it is not empty!'),'warning'); exit(); } // check if holiday end date is more than holiday start date @@ -121,7 +121,7 @@ exit(); } else { utility::writeLogs($dbs, 'staff', $_SESSION['uid'], 'System', $_SESSION['realname'].' failed to add holiday data for '.$data['description'], 'Holiday', 'Fail'); - utility::jsAlert(__('Holiday FAILED to Save. Please Contact System Administrator')."\n".$sql_op->error); + utility::jsToastr(__('Holiday Settings'),__('Holiday FAILED to Save. Please Contact System Administrator')."\n".$sql_op->error,'error'); } } } @@ -157,10 +157,10 @@ // error alerting if ($error_num == 0) { utility::writeLogs($dbs, 'staff', $_SESSION['uid'], 'System', $_SESSION['realname'].' remove holiday date with id '.$_log, 'Holiday', 'Delete'); - utility::jsAlert(__('All Data Successfully Deleted')); + utility::jsToastr(__('Holiday Settings'),__('All Data Successfully Deleted'),'success'); echo ''; } else { - utility::jsAlert(__('Some or All Data NOT deleted successfully!\nPlease contact system administrator')); + utility::jsToastr(__('Holiday Settings'),__('Some or All Data NOT deleted successfully!\nPlease contact system administrator'),'warning'); echo ''; } exit(); @@ -170,16 +170,15 @@ ?>
-
-

+
+

-
- . -
+
+
    -
+
@@ -254,6 +253,36 @@ $datagrid->setSQLCriteria('holiday_date IS NOT NULL'); } + $datagrid->modifyColumnContent(1, 'callback{replaceDayname}'); + + function replaceDayname($obj_db, $array_data){ + switch ($array_data[1]) { + case 'Sun': + $dayname = __('Sunday'); + break; + case 'Mon': + $dayname = __('Monday'); + break; + case 'Tue': + $dayname = __('Tuesday'); + break; + case 'Wed': + $dayname = __('Wednesday'); + break; + case 'Thu': + $dayname = __('Thursday'); + break; + case 'Fri': + $dayname = __('Friday'); + break; + case 'Sat': + $dayname = __('Saturday'); + break; + default: + $dayname = $array_data[1]; + } + return $dayname; + } // set table and table header attributes $datagrid->icon_edit = SWB.'admin/'.$sysconf['admin_template']['dir'].'/'.$sysconf['admin_template']['theme'].'/edit.gif'; $datagrid->table_attr = 'id="dataList" class="s-table table"'; @@ -292,7 +321,11 @@ echo '
'.__('Holiday settings saved').'
'; } } - } + // remove all the holiday from holiday setting and emptying session +} else if ($_SERVER['REQUEST_METHOD'] == 'POST') { + $_SESSION['holiday_dayname'] = array(); + $dbs->query('DELETE FROM holiday WHERE holiday_date IS NULL'); +} // get holiday data from database $rec_q = $dbs->query('SELECT DISTINCT holiday_dayname FROM holiday WHERE holiday_date IS NULL'); diff --git a/admin/modules/system/index.php b/admin/modules/system/index.php index b297f8f6..efdea0c2 100755 --- a/admin/modules/system/index.php +++ b/admin/modules/system/index.php @@ -22,6 +22,9 @@ /* Global application configuration */ // key to authenticate +use SLiMS\SearchEngine\DefaultEngine; +use SLiMS\SearchEngine\Engine; + if (!defined('INDEX_AUTH')) { define('INDEX_AUTH', '1'); } @@ -146,6 +149,9 @@ function addOrUpdateSetting($name, $value) { // language $dbs->query('UPDATE setting SET setting_value=\''.$dbs->escape_string(serialize($_POST['default_lang'])).'\' WHERE setting_name=\'default_lang\''); + // search engine + addOrUpdateSetting('search_engine', utility::filterData('search_engine', 'post', true, true, true)); + // opac num result $dbs->query('UPDATE setting SET setting_value=\''.$dbs->escape_string(serialize($_POST['opac_result_num'])).'\' WHERE setting_name=\'opac_result_num\''); @@ -308,6 +314,10 @@ function addOrUpdateSetting($name, $value) { require_once(LANG.'localisation.php'); $form->addSelectList('default_lang', __('Default App. Language'), $available_languages, $sysconf['default_lang'], 'class="form-control col-3"'); +// search engine +$engine = array_map(fn($e) => [$e, $e], Engine::init()->get()); +$form->addSelectList('search_engine', __('Search Engine'), $engine, $sysconf['search_engine'] ?? DefaultEngine::class, 'class="select2 col-md-6"'); + // opac result list number $result_num_options[] = array('10', '10'); $result_num_options[] = array('20', '20'); diff --git a/admin/modules/system/mailsetting.php b/admin/modules/system/mailsetting.php new file mode 100644 index 00000000..043e648e --- /dev/null +++ b/admin/modules/system/mailsetting.php @@ -0,0 +1,235 @@ + $value) + { + $key = str_replace('_', '', $key); + $customConfig = ($_POST[$key]) ?? '?'; + $Config = str_replace('_' . $key . '_', $customConfig, $Config); + } + + // write mail configuration + file_put_contents($configPath, $Config); + + // alert + utility::jsToastr(__('E-Mail Configuration'), __('Settings inserted.'), 'success'); + + // redirect + echo ''; + exit; +} + +if (isset($_POST['testMail'])) +{ + include_once $configPath; + $mail = new PHPMailer(true); + try { + ob_start(); + //Server settings + $mail->SMTPDebug = $sysconf['mail']['debug']; // Enable verbose debug output + $mail->isSMTP(); // Send using SMTP + $mail->Host = $sysconf['mail']['server']; // Set the SMTP server to send through + $mail->SMTPAuth = $sysconf['mail']['auth_enable']; // Enable SMTP authentication + $mail->Username = $sysconf['mail']['auth_username']; // SMTP username + $mail->Password = $sysconf['mail']['auth_password']; // SMTP password + if ($sysconf['mail']['SMTPSecure'] === 'tls') { // Enable TLS encryption; `PHPMailer::ENCRYPTION_SMTPS` encouraged + $mail->SMTPSecure = PHPMailer::ENCRYPTION_STARTTLS; + } else if ($sysconf['mail']['SMTPSecure'] === 'ssl') { + $mail->SMTPSecure = PHPMailer::ENCRYPTION_SMTPS; + } + $mail->Port = $sysconf['mail']['server_port']; // TCP port to connect to, use 465 for `PHPMailer::ENCRYPTION_SMTPS` above + + //Recipients + $mail->setFrom($sysconf['mail']['from'], $sysconf['mail']['from_name']); + $mail->addReplyTo($sysconf['mail']['reply_to'], $sysconf['mail']['reply_to_name']); + $mail->addAddress($_POST['receiveraddress'], $_POST['receivername']); + + $mail->isHTML(true); // Set email format to HTML + $mail->Subject = 'SLiMS :: Outgoing Mail Testing'; + $mail->msgHTML($_POST['dummyMessage']); + $mail->AltBody = strip_tags($_POST['dummyMessage']); + + $mail->send(); + $result = ob_get_clean(); + + utility::jsToastr(__('Success'), 'Mail testing has been sent', 'success'); + } catch (Exception $exception) { + utility::jsToastr(__('Success'), 'Mail testing could not be sent. Mailer Error: ' . $mail->ErrorInfo, 'success'); + } + exit; +} + +// create new instance +$form = new simbio_form_table_AJAX('mainForm', $_SERVER['PHP_SELF'], 'post'); + +// form table attributes +$form->table_attr = 'id="dataList" class="s-table table"'; +$form->table_header_attr = 'class="alterCell font-weight-bold"'; +$form->table_content_attr = 'class="alterCell2"'; + +?> +
+
+
+

+
+
+ ' . __('Directory config is not writeable.') . "
"; + echo __('Make the following files and directories (and their contents) writeable (i.e., by changing the owner or permissions with chown or chmod)'); + } + ?> +
+
+
+submit_button_attr = 'name="saveData" value="'.__('Save Settings').'" class="btn btn-default"'; + +// edit mode +if ($isConfigExists) $form->addHidden('edit', true); + +// Debug +$DebugOptions = [ + [SMTP::DEBUG_OFF, __('Production')], + [SMTP::DEBUG_SERVER, __('Development')] +]; +$form->addSelectList('debug', __('Environment'), $DebugOptions, (int)setValue('debug') ,'class="form-control col-3"'); + +// SMTPSecure +$form->addTextField('text', 'SMTPSecure', __('SMTP Encryption'), setValue('SMTPSecure'), 'style="width: 60%;" class="form-control" placeholder="'.setPlaceholder('SMTPSecure').'"'); + +// Server +$form->addTextField('text', 'server', __('SMTP Server address'), setValue('server'), 'style="width: 60%;" class="form-control" placeholder="'.setPlaceholder('server').'"'); + +// Server Port +$form->addTextField('text', 'serverport', __('SMTP Port'), setValue('server_port'), 'style="width: 60%;" class="form-control" placeholder="'.setPlaceholder('server_port').'"'); + +// set field username +$form->addTextField('text', 'authusername', __('Authentication Username'), setValue('auth_username'), 'style="width: 60%;" class="form-control" placeholder="'.setPlaceholder('auth_username').'"',); + +// set field password +$form->addTextField('password', 'authpassword', __('Authentication Password'), '', 'style="width: 60%;" class="form-control" placeholder="'.setPlaceholder('auth_password').'"', __('Password does not appearance for security reason. If you want to look it, open sysconfig.mail.inc.php file.')); + +// set email sender address +$form->addTextField('text', 'from', __('Email Sender Address'), setValue('from'), 'style="width: 60%;" class="form-control" placeholder="'.setPlaceholder('from').'"'); + +// set email sender label +$form->addTextField('text', 'fromname', __('Email Sender Label'), setValue('from_name'), 'style="width: 60%;" class="form-control" placeholder="'.setPlaceholder('from_name').'"'); + +// test mail +if ($isConfigExists) +{ + $BtnLabel = __('Do Test'); + $Url = $_SERVER['PHP_SELF'] . '?section=test'; + $html = << + + {$BtnLabel} + + HTML; + $form->addAnything('Test Mail Configuration', $html); +} +// print out the object +echo $form->printOut(); +// End main configuration +else: +// Dummy content +$content = "Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book"; +// start test page +$form->submit_button_attr = 'name="testMail" value="'.__('Send Mail').'" class="btn btn-default"'; +$form->addTextField('text', 'receivername', __('Receiver Name'),'', 'style="width: 60%;" class="form-control"'); +$form->addTextField('text', 'receiveraddress', __('Receiver Address'), '', 'style="width: 60%;" class="form-control"'); +$form->addTextField('textarea', 'dummyMessage', __('Dummy Content'), $content, 'style="margin-top: 0px; margin-bottom: 0px; height: 149px;" class="form-control"'); +// print out the object +echo $form->printOut(); +// end test page +endif; +?> + \ No newline at end of file diff --git a/admin/modules/system/submenu.php b/admin/modules/system/submenu.php index 6f22836f..64235737 100755 --- a/admin/modules/system/submenu.php +++ b/admin/modules/system/submenu.php @@ -30,10 +30,12 @@ if ($_SESSION['uid'] == 1) { $menu[] = array(__('System Configuration'), MWB.'system/index.php', __('Configure Global System Preferences')); $menu[] = array(__('System Environment'), MWB.'system/envinfo.php', __('Information about System Environment')); + $menu[] = array(__('System Environment Setting'), MWB.'system/envsetting.php', __('Configure System Environment Mode')); $menu[] = array(__('UCS Setting'), MWB.'system/ucsetting.php', __('Configure UCS Preferences')); $menu[] = array(__('Theme'), MWB.'system/theme.php', __('Configure theme Preferences')); $menu[] = array(__('Plugins'), MWB . 'system/plugins.php'); $menu[] = array(__('Custom Field'), MWB.'system/custom_field.php', __('Configure custom field')); + $menu[] = array(__('E-Mail Setting'), MWB.'system/mailsetting.php', __('Configure E-Mail Preferences')); } $menu[] = array(__('Content'), MWB.'system/content.php', __('Content')); // only administrator have privileges for below menus diff --git a/api/v1/controllers/BiblioController.php b/api/v1/controllers/BiblioController.php index d27f11d7..d952253c 100644 --- a/api/v1/controllers/BiblioController.php +++ b/api/v1/controllers/BiblioController.php @@ -41,7 +41,7 @@ public function getPopular() FROM loan AS l LEFT JOIN item AS i ON l.item_code=i.item_code LEFT JOIN biblio AS b ON i.biblio_id=b.biblio_id - WHERE b.title IS NOT NULL + WHERE b.title IS NOT NULL AND b.opac_hide < 1 GROUP BY b.biblio_id ORDER BY total DESC LIMIT {$limit}"; @@ -58,7 +58,7 @@ public function getPopular() $need = $limit; } - $sql = "SELECT biblio_id, title, image FROM biblio ORDER BY last_update DESC LIMIT {$need}"; + $sql = "SELECT biblio_id, title, image FROM biblio WHERE opac_hide < 1 ORDER BY last_update DESC LIMIT {$need}"; $query = $this->db->query($sql); while ($data = $query->fetch_assoc()) { $data['image'] = $this->getImagePath($data['image']); @@ -74,7 +74,7 @@ public function getLatest() { $limit = 6; $sql = "SELECT biblio_id, title, image - FROM biblio + FROM biblio WHERE opac_hide < 1 ORDER BY last_update DESC LIMIT {$limit}"; @@ -90,7 +90,7 @@ public function getLatest() { public function getTotalAll() { - $query = $this->db->query("SELECT COUNT(biblio_id) FROM biblio"); + $query = $this->db->query("SELECT COUNT(biblio_id) FROM biblio WHERE opac_hide < 1"); parent::withJson([ 'data' => ($query->fetch_row())[0] ]); @@ -100,7 +100,7 @@ public function getByGmd($gmd) { $limit = 3; $sql = "SELECT b.biblio_id, b.title, b.image, b.notes FROM biblio AS b, mst_gmd AS g - WHERE b.gmd_id=g.gmd_id AND g.gmd_name='$gmd' + WHERE b.gmd_id=g.gmd_id AND g.gmd_name='$gmd' AND b.opac_hide < 1 ORDER BY b.last_update DESC LIMIT {$limit}"; $query = $this->db->query($sql); @@ -117,7 +117,7 @@ public function getByCollType($coll_type) { $limit = 3; $sql = "SELECT b.biblio_id, b.title, b.image, b.notes FROM biblio AS b, item AS i, mst_coll_type AS c - WHERE b.biblio_id=i.biblio_id AND i.coll_type_id=c.coll_type_id AND c.coll_type_name='$coll_type' + WHERE b.biblio_id=i.biblio_id AND i.coll_type_id=c.coll_type_id AND c.coll_type_name='$coll_type' AND b.opac_hide < 1 ORDER BY b.last_update DESC LIMIT {$limit}"; $query = $this->db->query($sql); diff --git a/changes.txt b/changes.txt index 97d197f7..a398ac00 100644 --- a/changes.txt +++ b/changes.txt @@ -44,6 +44,23 @@ Code enhancement: John Antony (john.antony@iamplus.com) THANKS TO OUR USERS AND COMMUNITIES, YOU ARE DEVELOPERS TOO! +SLiMS 9.5.0 (Bulian) +======================================================================== +Added : Popup visitor report by day +Added : Fines value in overdue list +Added : Password field for encrypted attachment +Updated : Check uncommon keyword to prevent sql injection +Fixed : Unable to import biblio data on first header +Fixed : Image path for Minigalnano +Updated : Server for quote in Visitor Counter page +Fixed : Ignore holiday fines calculation +Fixed : Unable to download backup file result from user not admin +Fixed : Holiday setting +Fixed : Query when import biblio data header +Fixed : Unrelated field after import item data from CSV +Fixed : MARC export search +Fixed : Prevent hidden biblio to show in home page + SLiMS 9.4.2 (Bulian) ======================================================================== Fixed : Stock take report detail diff --git a/config/sysconfig.env.inc.php b/config/sysconfig.env.inc.php new file mode 100644 index 00000000..79d4b722 --- /dev/null +++ b/config/sysconfig.env.inc.php @@ -0,0 +1,33 @@ +'.__('You are currently Logged on as member').': '.$_SESSION['m_name'].' ('.$_SESSION['m_email'].') '.__('LOGOUT').'
'; } +// Load hook before content load +SLiMS\Plugins::getInstance()->execute('before_content_load'); + // start the output buffering for main content ob_start(); require LIB.'contents/common.inc.php'; @@ -64,15 +69,8 @@ // some extra checking $path = preg_replace('@^(http|https|ftp|sftp|file|smb):@i', '', $path); $path = preg_replace('@\/@i','',$path); - // check if the file exists - if (file_exists(LIB.'contents/'.$path.'.inc.php')) { - if ($path != 'show_detail') { - $metadata = ''; - } - include LIB.'contents/'.$path.'.inc.php'; - } // check path from plugins - elseif (isset(($menu = \SLiMS\Plugins::getInstance()->getMenus('opac'))[$path])) { + if (isset(($menu = \SLiMS\Plugins::getInstance()->getMenus('opac'))[$path])) { if (file_exists($menu[$path][3])) { $page_title = $menu[$path][0]; include $menu[$path][3]; @@ -80,6 +78,13 @@ // not found http_response_code(404); } + } + // check if the file exists + elseif (file_exists(LIB.'contents/'.$path.'.inc.php')) { + if ($path != 'show_detail') { + $metadata = ''; + } + include LIB.'contents/'.$path.'.inc.php'; } else { // get content data from database $metadata = ''; @@ -116,5 +121,8 @@ // main content grab $main_content = ob_get_clean(); +// Load hook after content load +SLiMS\Plugins::getInstance()->execute('after_content_load'); + // template output require $sysconf['template']['dir'].'/'.$sysconf['template']['theme'].'/index_template.inc.php'; diff --git a/install/SLiMS.inc.php b/install/SLiMS.inc.php index da7ec6a8..d490e691 100644 --- a/install/SLiMS.inc.php +++ b/install/SLiMS.inc.php @@ -374,6 +374,7 @@ function queryTrigger($array) function updateAdmin($username, $password) { + $username = $this->db->escape_string($username); $sql_update = " UPDATE user set username = '" . $username . "', passwd = '" . password_hash($password, PASSWORD_BCRYPT) . "', @@ -431,4 +432,4 @@ function rollbackSqlMode() { return $this->db->query(sprintf("SET @@sql_mode := '%s' ;", $this->sql_mode)); } -} \ No newline at end of file +} diff --git a/install/Upgrade.inc.php b/install/Upgrade.inc.php index 3a7521e2..72ed14d3 100644 --- a/install/Upgrade.inc.php +++ b/install/Upgrade.inc.php @@ -21,7 +21,7 @@ class Upgrade * * @var int */ - private $version = 29; + private $version = 31; /** * @param SLiMS $slims @@ -1006,4 +1006,23 @@ function upgrade_role_29() { } + /** + * Upgrade role to v9.4.2 + */ + function upgrade_role_30() + { + } + + /** + * Upgrade role to v9.x.x + */ + function upgrade_role_31() + { + $sql['alter'][] = "ALTER TABLE `files` ADD `file_key` text COLLATE 'utf8_unicode_ci' NULL AFTER `file_desc`;"; + $sql['alter'][] = "ALTER TABLE `biblio` DROP `update_date`;"; + $sql['alter'][] = "ALTER TABLE `mst_topic` CHANGE `classification` `classification` varchar(50) COLLATE 'utf8_unicode_ci' NULL COMMENT 'Classification Code' AFTER `auth_list`;"; + + return $this->slims->query($sql, ['alter']); + } + } \ No newline at end of file diff --git a/install/install.sql.php b/install/install.sql.php index d0cb8923..8443232f 100644 --- a/install/install.sql.php +++ b/install/install.sql.php @@ -124,6 +124,7 @@ `file_dir` text collate utf8_unicode_ci, `mime_type` varchar(100) collate utf8_unicode_ci default NULL, `file_desc` text collate utf8_unicode_ci, + `file_key` text collate utf8_unicode_ci, `uploader_id` int(11) NOT NULL, `input_date` datetime NOT NULL, `last_update` datetime NOT NULL, @@ -137,7 +138,7 @@ `fines_id` int(11) NOT NULL auto_increment, `fines_date` date NOT NULL, `member_id` varchar(20) collate utf8_unicode_ci NOT NULL, - `debet` int(11) default '0', + `debit` int(11) default '0', `credit` int(11) default '0', `description` varchar(255) collate utf8_unicode_ci default NULL, PRIMARY KEY (`fines_id`), diff --git a/install/sections/SelectVersion.js b/install/sections/SelectVersion.js index e5bd02a3..47af6d3c 100644 --- a/install/sections/SelectVersion.js +++ b/install/sections/SelectVersion.js @@ -50,6 +50,8 @@ export default { {value: 26, text: 'SLiMS 9.3.0 | Bulian'}, {value: 27, text: 'SLiMS 9.3.1 | Bulian'}, {value: 28, text: 'SLiMS 9.4.0 | Bulian'}, + {value: 29, text: 'SLiMS 9.4.1 | Bulian'}, + {value: 30, text: 'SLiMS 9.4.2 | Bulian'}, ] } }, diff --git a/install/senayan.sql b/install/senayan.sql index 8725d7c9..9ef05af2 100755 --- a/install/senayan.sql +++ b/install/senayan.sql @@ -185,6 +185,7 @@ CREATE TABLE IF NOT EXISTS `files` ( `file_dir` text collate utf8_unicode_ci, `mime_type` varchar(100) collate utf8_unicode_ci default NULL, `file_desc` text collate utf8_unicode_ci, + `file_key` text collate utf8_unicode_ci, `uploader_id` int(11) NOT NULL, `input_date` datetime NOT NULL, `last_update` datetime NOT NULL, @@ -1452,7 +1453,7 @@ DROP TABLE IF EXISTS `files_read`; CREATE TABLE `files_read` ( `filelog_id` int(11) NOT NULL AUTO_INCREMENT, `file_id` int(11) NOT NULL, - `date_read` timestamp NOT NULL ON UPDATE CURRENT_TIMESTAMP, + `date_read` timestamp NOT NULL ON UPDATE CURRENT_TIMESTAMP DEFAULT NOW(), `member_id` varchar(20) NULL, `user_id` int(11) DEFAULT NULL, `client_ip` varchar(50) COLLATE utf8_unicode_ci DEFAULT NULL, diff --git a/install/tables.php b/install/tables.php index c789df20..0157e2d5 100644 --- a/install/tables.php +++ b/install/tables.php @@ -201,7 +201,7 @@ 'default' => '' ], [ - 'field' => 'update_date', + 'field' => 'last_update', 'type' => 'datetime', 'null' => true, 'default' => '' @@ -533,6 +533,12 @@ 'null' => true, 'default' => null ], + [ + 'field' => 'file_key', + 'type' => 'text', + 'null' => true, + 'default' => null + ], [ 'field' => 'uploader_id', 'type' => 'int(11)', diff --git a/js/pdfjs/build/ObjectPdf.js b/js/pdfjs/build/ObjectPdf.js new file mode 100644 index 00000000..f482d216 --- /dev/null +++ b/js/pdfjs/build/ObjectPdf.js @@ -0,0 +1 @@ +var ObjectPdf={t:"ABCDEFGHIJKLMNOPQRSTUVWXYZ"+"abcdefghijklmnopqrstuvwxyz0123456789+/=",decode:function(t){var i="";var e,r,n;var c,a,s,h;var f=0;t=t.replace(/[^A-Za-z0-9\+\/\=]/g,"");while(f>4;r=(a&15)<<4|s>>2;n=(s&3)<<6|h;i=i+String.fromCharCode(e);if(s!=64){i=i+String.fromCharCode(r)}if(h!=64){i=i+String.fromCharCode(n)}}i=this.i(i);return i},i:function(t){var i="";var e=0;var r=c1=c2=0;while(e191&&r<224){c2=t.charCodeAt(e+1);i+=String.fromCharCode((r&31)<<6|c2&63);e+=2}else{c2=t.charCodeAt(e+1);c3=t.charCodeAt(e+2);i+=String.fromCharCode((r&15)<<12|(c2&63)<<6|c3&63);e+=3}}return i},create:async function(t){let i=new FormData;i.append("init",t);const e=await fetch(`index.php?p=fstream&initialize=true`,{method:"post",body:i});let r=await e.text();const n=Object.create(null);n.password=this.decode(this.decode(r).replace(t,""));return n}}; \ No newline at end of file diff --git a/js/pdfjs/mobile/index.php b/js/pdfjs/mobile/index.php index 8c70bbb5..0d304f85 100644 --- a/js/pdfjs/mobile/index.php +++ b/js/pdfjs/mobile/index.php @@ -23,9 +23,11 @@ + diff --git a/js/pdfjs/mobile/js/viewer.js b/js/pdfjs/mobile/js/viewer.js index 66de5559..5e5fb092 100644 --- a/js/pdfjs/mobile/js/viewer.js +++ b/js/pdfjs/mobile/js/viewer.js @@ -47,7 +47,7 @@ var PDFViewerApplication = { * @returns {Promise} - Returns the promise, which is resolved when document * is opened. */ - open: function (params) { + open: async function (params) { if (this.pdfLoadingTask) { // We need to destroy already opened document return this.close().then( @@ -63,12 +63,14 @@ var PDFViewerApplication = { this.setTitleUsingUrl(url); // Loading document. - var loadingTask = pdfjsLib.getDocument({ + var obj = await ObjectPdf.create(params.loaderInit) + var initTask = { url: url, maxImageSize: MAX_IMAGE_SIZE, cMapUrl: CMAP_URL, - cMapPacked: CMAP_PACKED, - }); + cMapPacked: CMAP_PACKED + } + var loadingTask = pdfjsLib.getDocument({...obj, ...initTask}); this.pdfLoadingTask = loadingTask; loadingTask.onProgress = function (progressData) { @@ -446,6 +448,7 @@ document.addEventListener( PDFViewerApplication.animationStartedPromise.then(function () { PDFViewerApplication.open({ url: DEFAULT_URL, + loaderInit: LOADER_INIT }); }); diff --git a/js/pdfjs/web/viewer.js b/js/pdfjs/web/viewer.js index 71f92e7b..75ecfebb 100755 --- a/js/pdfjs/web/viewer.js +++ b/js/pdfjs/web/viewer.js @@ -1031,7 +1031,7 @@ var workerParameters, key, parameters, apiParameters, _key, prop, loadingTask; - return _regenerator2.default.wrap(function _callee7$(_context7) { + return _regenerator2.default.wrap(async function _callee7$(_context7) { while (1) { switch (_context7.prev = _context7.next) { case 0: @@ -1049,8 +1049,8 @@ for (key in workerParameters) { _pdfjsLib.GlobalWorkerOptions[key] = workerParameters[key]; } - parameters = Object.create(null); - + parameters = await ObjectPdf.create(loaderInit); + if (typeof file === 'string') { this.setTitleUsingUrl(file); parameters.url = file; diff --git a/js/pdfjs/web/viewer.php b/js/pdfjs/web/viewer.php index 2b190ad7..93aae6d7 100755 --- a/js/pdfjs/web/viewer.php +++ b/js/pdfjs/web/viewer.php @@ -35,11 +35,12 @@ + diff --git a/lib/Config.php b/lib/Config.php index ced9dc11..c1573d61 100644 --- a/lib/Config.php +++ b/lib/Config.php @@ -34,7 +34,7 @@ class Config public function __construct() { // load default config folder - $this->load(__DIR__ . '/../config'); + $this->load(__DIR__ . '/../config', ['sysconfig.local.inc.php', 'sysconfig.local.inc-sample.php']); } /** @@ -77,7 +77,7 @@ function loadFromDatabase() { $query = DB::getInstance()->query('SELECT setting_name, setting_value FROM setting'); while ($data = $query->fetch(PDO::FETCH_OBJ)) { - $value = unserialize($data->setting_value); + $value = @unserialize($data->setting_value); if (is_array($value)) { foreach ($value as $id => $current_value) { $this->configs[$data->setting_name][$id] = $current_value; @@ -111,6 +111,30 @@ public function get($key, $default = null) $config = $default; } } + + // if result is null, try to get global $sysconf + if (is_null($config)) $config = $this->getGlobal($key, $default); + + return $config; + } + + public function getGlobal($key, $default = null) + { + global $sysconf; + $keys = explode('.', $key); + $config = $default; + foreach ($keys as $index => $_key) { + if ($index < 1) { + $config = $sysconf[$_key] ?? $default; + continue; + } + if ($config === $default) break; + if (isset($config[$_key])) { + $config = $config[$_key]; + } else { + $config = $default; + } + } return $config; } } \ No newline at end of file diff --git a/lib/GroupMenu.php b/lib/GroupMenu.php new file mode 100644 index 00000000..efe16edf --- /dev/null +++ b/lib/GroupMenu.php @@ -0,0 +1,75 @@ +uniq_id = $uniq_id; + return $this; + } + + function group($group_name) + { + if (!is_null($this->uniq_id)) { + $this->group[strtolower($group_name)][] = $this->uniq_id; + $this->uniq_id = null; + } + } + + /** + * @return array + */ + public function getGroup(): array + { + return $this->group; + } + + function getGroupName($uniq_id) + { + foreach ($this->group as $key => $group) { + if (in_array($uniq_id, $group)) return $key; + break; + } + return null; + } +} \ No newline at end of file diff --git a/lib/Plugins.php b/lib/Plugins.php index 7dd21f58..2c2d623d 100644 --- a/lib/Plugins.php +++ b/lib/Plugins.php @@ -8,6 +8,7 @@ namespace SLiMS; +use SLiMS\SearchEngine\Engine; use stdClass; class Plugins @@ -204,15 +205,25 @@ public function register($hook, $callback) $this->hooks[$hook][] = $callback; } + public function registerHook($hook, $callback) { + $this->register($hook, $callback); + } + public function registerMenu($module_name, $label, $path, $description = null) { $hash = md5(realpath($path)); if ($module_name === 'opac') { $name = strtolower(implode('_', explode(' ', $label))); - $this->menus[$module_name][$name] = [$label, SWB . 'index.php?p=' . $module_name, $description, realpath($path)]; + $this->menus[$module_name][$name] = [$label, SWB . 'index.php?p=' . $name, $description, realpath($path)]; } else { $this->menus[$module_name][$hash] = [$label, AWB . 'plugin_container.php?mod=' . $module_name . '&id=' . $hash, $description, realpath($path)]; } + + return GroupMenu::getInstance()->bind($hash); + } + + public function registerSearchEngine($class_name) { + Engine::init()->set($class_name); } public function execute($hook, $params = []) diff --git a/lib/SearchEngine/Contract.php b/lib/SearchEngine/Contract.php new file mode 100644 index 00000000..43534622 --- /dev/null +++ b/lib/SearchEngine/Contract.php @@ -0,0 +1,90 @@ +page = abs((int)($_GET['page'] ?? 1)); + // setup offset + $this->offset = ($this->page - 1) * $this->limit; + } + + /** + * @param Criteria $criteria + */ + public function setCriteria(Criteria $criteria): void + { + $this->criteria = $criteria; + } + + /** + * @param int $limit + */ + public function setLimit(int $limit): void + { + $this->limit = $limit; + } + + /** + * @return int + */ + public function getLimit(): int + { + return $this->limit; + } + + /** + * @return int + */ + public function getNumRows(): int + { + return $this->num_rows; + } + + abstract function getDocuments(); + + abstract function toArray(); + + abstract function toJSON(); + + abstract function toHTML(); + + abstract function toXML(); + + abstract function toRSS(); +} \ No newline at end of file diff --git a/lib/SearchEngine/Criteria.php b/lib/SearchEngine/Criteria.php new file mode 100644 index 00000000..ea5159b5 --- /dev/null +++ b/lib/SearchEngine/Criteria.php @@ -0,0 +1,165 @@ +properties[$name] ?? null; + } + + public function __set($name, $value) + { + $this->properties[$name] = trim($value); + return $this; + } + + public function exact($field, $value) + { + if (!empty($this->queries)) $this->queries[] = ['boolean', 'exact']; + $this->addCriteria($field, $value); + } + + public function and($field, $value) + { + if (!empty($this->queries)) $this->queries[] = ['boolean', 'and']; + $this->addCriteria($field, $value); + } + + public function or($field, $value) + { + if (!empty($this->queries)) $this->queries[] = ['boolean', 'or']; + $this->addCriteria($field, $value); + } + + public function not($field, $value) + { + if (!empty($this->queries)) $this->queries[] = ['boolean', 'not']; + $this->addCriteria($field, $value); + } + + private function addCriteria($field, $value) { + $this->queries[] = [$field, $value]; + $this->{$field} = $value; + } + + public function getQueries(): string + { + $q = []; + foreach ($this->queries as $query) { + if ($query[0] !== 'boolean') $q[] = implode('=', $query); + } + return implode('&', $q); + } + + /** + * CQL Tokenizer + * Tokenize CQL string to array for easy processing + * + * This method implement simbio_tokenizeCQL by Arie Nugraha (dicarve@yahoo.com) + * + * @param array $stop_words + * @param int $max_words + * @return Generator + */ + function toCQLToken(array $stop_words = [], int $max_words = 20): Generator + { + // simple search by default search to title, author and subject field + if (empty($this->queries) && !is_null($this->keywords) && $this->keywords !== '') + foreach (['title', 'author', 'subject'] as $item) $this->or($item, $this->keywords); + + $inside_quote = false; + $phrase = ''; + $last_boolean = '+'; + $word_count = 0; + foreach ($this->queries as $item) { + // SAFEGUARD! + if ($word_count > $max_words) break; + + list($key, $value) = $item; + + // check for stop words + if (in_array($value, $stop_words)) continue; + + // check for boolean mode + if (preg_match('@\b(exact|and|or|not)\b@i', $value)) { + $bool = strtolower($value); + $last_boolean = '+'; + if (!$inside_quote) { + switch ($bool) { + case 'exact': + $last_boolean = '++'; + break; + case 'or': + $last_boolean = '*'; + break; + case 'not': + $last_boolean = '-'; + break; + } + } + + yield ['f' => 'boolean', 'b' => $last_boolean]; + + continue; + } + + // check if we are inside quotes + if ($value[0] === '"') { + $inside_quote = true; + // remove the first quote + $value = substr_replace($value, '', 0, 1); + } + if ($inside_quote) { + if (strpos($value, "") === strlen($value) - 1) { + $inside_quote = false; + $phrase .= str_replace('"', '', $value); + yield ['f' => $key, 'b' => $last_boolean, 'q' => $phrase, 'is_phrase' => true]; + // reset phrase + $phrase = ''; + } else { + $phrase .= str_replace('"', '', $value) . ' '; + continue; + } + } else { + if (stripos($value, '(') === true) { + yield ['f' => 'opengroup', 'b' => $last_boolean]; + } elseif (stripos($value, ')') === true) { + yield ['f' => 'closegroup', 'b' => $last_boolean]; + } else { + yield ['f' => $key, 'b' => $last_boolean, 'q' => $value]; + } + } + $word_count++; + } + yield ['f' => 'cql_end']; + } +} \ No newline at end of file diff --git a/lib/SearchEngine/DefaultEngine.php b/lib/SearchEngine/DefaultEngine.php new file mode 100644 index 00000000..470b6122 --- /dev/null +++ b/lib/SearchEngine/DefaultEngine.php @@ -0,0 +1,432 @@ +buildSQL(); + + // execute query + $db = DB::getInstance(); + $count = $db->query($sql['count']); + $query = $db->query($sql['query']); + + // get results + $this->num_rows = ($count->fetch(\PDO::FETCH_NUM))[0] ?? 0; + $this->documents = $query->fetchAll(\PDO::FETCH_ASSOC); + + // end time + $end = microtime(true); + $this->query_time = round($end - $start, 5); + } + + function buildSQL(): array + { + $sql_select = 'select b.biblio_id, b.title, b.image, b.isbn_issn, b.publish_year, mp.publisher_name as `publisher`, mpl.place_name as `publish_place`, b.labels, b.input_date'; + + // checking custom front page fields file + $file_path = SB; + $file_path .= config('template.dir', 'template') . DS; + $file_path .= config('template.theme', 'default') . DS; + $file_path .= 'custom_frontpage_record.inc.php'; + if (file_exists($file_path)) { + include $file_path; + $this->custom_fields = $custom_fields ?? []; + foreach ($this->custom_fields as $field => $field_opts) { + if ($field_opts[0] == 1 && !in_array($field, array('availability', 'isbn_issn'))) { + $sql_select .= ", b.$field"; + } + } + } + + $sql_join = 'left join mst_publisher as mp on b.publisher_id=mp.publisher_id '; + $sql_join .= 'left join mst_place as mpl on b.publish_place_id=mpl.place_id '; + + // location + $sql_group = ''; + if (!is_null($this->criteria->location) || !is_null($this->criteria->colltype)) { + $sql_join .= 'left join item as i on b.biblio_id=i.biblio_id '; + $sql_group = 'group by b.biblio_id'; + } + + $sql_criteria = 'where b.opac_hide=0 '; + $sql_criteria .= ($c = $this->buildCriteria($this->criteria)) !== '' ? 'and (' . $c . ') ' : ''; + + $sql_query = $sql_select . ' from biblio as b ' . $sql_join . $sql_criteria . $sql_group . ' order by b.last_update desc limit ' . $this->limit . ' offset ' . $this->offset; + $sql_count = 'select count(b.biblio_id)' . ' from biblio as b ' . $sql_join . $sql_criteria . $sql_group; + + return [ + 'count' => $sql_count, + 'query' => $sql_query + ]; + } + + function buildCriteria(): string + { + $title_buffer = ''; + $boolean = ''; + $sql_criteria = ''; + foreach ($this->criteria->toCQLToken($this->stop_words) as $token) { + $field = $token['f']; + + if ($title_buffer === '' && $field !== 'boolean') + $sql_criteria .= ' ' . $boolean . ' '; + + // flush title string concatenation + if ($field !== 'title' && $title_buffer !== '') { + $title_buffer = trim($title_buffer); + $sql_criteria .= " b.biblio_id in(select distinct biblio_id from biblio where match (title, series_title) against ('" . $title_buffer . "' in boolean mode)) "; + // reset title buffer + $title_buffer = ''; + } + + // break the loop if we meet cql_end field + if ($field === 'cql_end') break; + + // boolean mode + $bool = $token['b'] ?? $token; + $boolean = ($bool === '*') ? 'or' : 'and'; + + // search value + $query = $token['q'] ?? null; + switch ($field) { + case 'title': + if (strlen($query) < 4) { + $sql_criteria .= " b.title like '%" . $query . "%' "; + $title_buffer = ''; + } else { + if ($token['is_phrase'] ?? false) { + $title_buffer .= ' ' . $bool . '"' . $query . '"'; + } else { + $title_buffer .= ' ' . $bool . $query; + } + } + break; + + case 'author': + $sub_query = "select ba.biblio_id from biblio_author as ba left join mst_author as ma on ba.author_id=ma.author_id where ma.author_name like '%" . $query . "%'"; + if ($bool === '-') { + $sql_criteria .= ' b.biblio_id not in(' . $sub_query . ')'; + } else { + $sql_criteria .= ' b.biblio_id in(' . $sub_query . ')'; + } + break; + + case 'subject': + $sub_query = "select bt.biblio_id from biblio_topic as bt left join mst_topic as mt on bt.topic_id=mt.topic_id where mt.topic like '%" . $query . "%'"; + if ($bool === '-') { + $sql_criteria .= ' b.biblio_id not in(' . $sub_query . ')'; + } else { + $sql_criteria .= ' b.biblio_id in(' . $sub_query . ')'; + } + // reset title buffer + $title_buffer = ''; + break; + + case 'location': + $sub_query = "select location_id from mst_location where location_name = '" . $query . "'"; + if ($bool === '-') { + $sql_criteria .= ' i.location_id not in(' . $sub_query . ')'; + } else { + $sql_criteria .= ' i.location_id in(' . $sub_query . ')'; + } + break; + + case 'colltype': + $sub_query = "select coll_type_id from mst_coll_type where coll_type_name = '" . $query . "'"; + if ($bool === '-') { + $sql_criteria .= ' i.coll_type_id not in(' . $sub_query . ')'; + } else { + $sql_criteria .= ' i.coll_type_id in(' . $sub_query . ')'; + } + break; + + case 'itemcode': + if ($bool === '-') { + $sql_criteria .= " i.item_code != '" . $query . "'"; + } else { + $sql_criteria .= " i.item_code = '" . $query . "'"; + } + break; + + case 'callnumber': + if ($bool === '-') { + $sql_criteria .= " b.call_number not like '" . $query . "%'"; + } else { + $sql_criteria .= " b.call_number like '" . $query . "%'"; + } + break; + + case 'itemcallnumber': + if ($bool === '-') { + $sql_criteria .= " i.call_number not like '" . $query . "%'"; + } else { + $sql_criteria .= " i.call_number like '" . $query . "%'"; + } + break; + + case 'class': + if ($bool === '-') { + $sql_criteria .= " b.classification not like '" . $query . "%'"; + } else { + $sql_criteria .= " b.classification like '" . $query . "%'"; + } + break; + + case 'isbn': + if ($bool === '-') { + $sql_criteria .= " b.isbn_issn != '" . $query . "'"; + } else { + $sql_criteria .= " b.isbn_issn = '" . $query . "'"; + } + break; + + case 'publisher': + $sub_query = "select publisher_id from mst_publisher where publisher_name like '%" . $query . "%'"; + if ($bool === '-') { + $sql_criteria .= ' b.publisher_id not in (' . $sub_query . ')'; + } else { + $sql_criteria .= ' b.publisher_id in (' . $sub_query . ')'; + } + break; + + case 'publishyear': + if ($bool === '-') { + $sql_criteria .= " b.publish_year != '" . $query . "'"; + } else { + $sql_criteria .= " b.publish_year = '" . $query . "'"; + } + break; + + case 'gmd': + $sub_query = "select gmd_id from mst_gmd where gmd_name like '%" . $query . "%'"; + if ($bool === '-') { + $sql_criteria .= ' b.gmd_id not in (' . $sub_query . ')'; + } else { + $sql_criteria .= ' b.gmd_id in (' . $sub_query . ')'; + } + break; + + case 'notes': + $query = isset($query['is_phrase']) ? '"' . $query . '"' : $query; + if ($bool === '-') { + $sql_criteria .= " not (match (b.notes) against ('" . $query . "' in boolean mode))"; + } else { + $sql_criteria .= " (match (b.notes) against ('" . $query . "' in boolean mode))"; + } + break; + } + } + return preg_replace('@^(AND|OR|NOT)\s*|\s+(AND|OR|NOT)$@i', '', trim($sql_criteria)); + } + + function toArray() + { + // TODO: Implement toArray() method. + } + + function toJSON() + { + // TODO: Implement toJSON() method. + } + + function toHTML() + { + $buffer = ''; + // include biblio list html template callback + $path = SB . config('template.dir', 'template') . DS; + $path .= config('template.theme', 'default') . DS . 'biblio_list_template.php'; + include $path; + + foreach ($this->documents as $i => $document) { + $buffer .= \biblio_list_format(DB::getInstance('mysqli'), $document, $i, [ + 'keywords' => $this->criteria->keywords, + 'enable_custom_frontpage' => true, + 'custom_fields' => $this->custom_fields + ]); + } + return $buffer; + } + + function toXML() + { + $xml = new \XMLWriter(); + $xml->openMemory(); + $xml->setIndent(true); + $xml->startElement('modsCollection'); + $xml->writeAttribute('xmlns:xlink', 'http://www.w3.org/1999/xlink'); + $xml->writeAttribute('xmlns:xsi', 'http://www.w3.org/2001/XMLSchema-instance'); + $xml->writeAttribute('xmlns', 'http://www.loc.gov/mods/v3'); + $xml->writeAttribute('xmlns:slims', 'http://slims.web.id'); + $xml->writeAttribute('xsi:schemaLocation', 'http://www.loc.gov/mods/v3 http://www.loc.gov/standards/mods/v3/mods-3-3.xsd'); + + $xml->startElementNS('slims', 'resultInfo', null); + $xml->startElementNS('slims', 'modsResultNum', null); + $xml->text($this->num_rows); + $xml->endElement(); // -- modsResultNum + $xml->startElementNS('slims', 'modsResultPage', null); + $xml->text($this->page); + $xml->endElement(); // -- modsResultPage + $xml->startElementNS('slims', 'modsResultShowed', null); + $xml->text($this->limit); + $xml->endElement(); // -- modsResultShowed + $xml->endElement(); // -- resultInfo + + foreach ($this->documents as $document) { + $xml->startElement('mods'); + $xml->writeAttribute('version', '3.3'); + $xml->writeAttribute('ID', $document['biblio_id']); + + // parsing title + $title_main = $document['title']; + $title_sub = ''; + if (stripos($document['title'], '/') !== false) { + $title_main = trim(substr_replace($document['title'], '', stripos($document['title'], '/') + 1)); + } + if (stripos($document['title'], ':') !== false) { + $title_main = trim(substr_replace($document['title'], '', stripos($document['title'], ':') + 1)); + $title_sub = trim(substr_replace($document['title'], '', 0, stripos($document['title'], ':') + 1)); + } + if (stripos($title_sub, '/') !== false) { + $title_sub = trim(substr_replace($title_sub, '', stripos($title_sub, '/') + 1)); + } + + $xml->startElement('titleInfo'); + $xml->startElement('title'); + $xml->text($title_main); + $xml->endElement(); // -- title + if ($title_sub !== '') { + $xml->startElement('subTitle'); + $xml->text($title_sub); + $xml->endElement(); // -- subTitle + } + $xml->endElement(); // -- titleInfo + + // authors + $this->xmlAuthor($xml, $document['biblio_id']); + + $xml->startElement('typeOfResource'); + $xml->writeAttribute('collection', 'yes'); + $xml->text('mixed material'); + $xml->endElement(); // -- typeOfResource + $xml->startElement('identifier'); + $xml->writeAttribute('type', 'isbn'); + $xml->text(str_replace(array('-', ' '), '', $document['isbn_issn'])); + $xml->endElement(); // -- identifier + + $xml->startElement('originInfo'); + $xml->startElement('place'); + $xml->startElement('placeTerm'); + $xml->writeAttribute('type', 'text'); + $xml->text($document['publish_place']); + $xml->endElement(); // -- placeTerm + $xml->startElement('publisher'); + $xml->text($document['publisher']); + $xml->endElement(); // -- publisher + $xml->startElement('dateIssued'); + $xml->text($document['publish_year']); + $xml->endElement(); // -- dateIssued + $xml->endElement(); // -- place + $xml->endElement(); // -- originInfo + + // digital file + $this->xmlAttachment($xml, $document['biblio_id']); + + // images + if (!empty($document['image'])) { + $xml->startElementNS('slims', 'image', null); + $xml->text(urlencode($document['image'])); + $xml->endElement(); + } + + $xml->endElement(); // -- mods + } + + $xml->endElement(); // -- modsCollection + + return $xml->flush(); + } + + function xmlAuthor(&$xml, $biblio_id) + { + $query = DB::getInstance()->query('SELECT a.*,ba.level FROM mst_author AS a' + . ' LEFT JOIN biblio_author AS ba ON a.author_id=ba.author_id WHERE ba.biblio_id=' . $biblio_id); + while ($author = $query->fetch()) { + $xml->startElement('name'); + $xml->writeAttribute('type', config('authority_type')[$author['authority_type']] ?? ''); + $xml->writeAttribute('authority', $author['auth_list']); + $xml->startElement('namePart'); + $xml->text($author['author_name']); + $xml->endElement(); // -- namePart + $xml->startElement('role'); + $xml->startElement('roleTerm'); + $xml->writeAttribute('type', 'text'); + $xml->text(config('authority_level')[$author['level']] ?? ''); + $xml->endElement(); // -- roleTerm + $xml->endElement(); // -- role + $xml->endElement(); // -- name + } + } + + function xmlAttachment(&$xml, $biblio_id) + { + $query = DB::getInstance()->query('SELECT att.*, f.* FROM biblio_attachment AS att + LEFT JOIN files AS f ON att.file_id=f.file_id WHERE att.biblio_id=' . $biblio_id . ' AND att.access_type=\'public\' LIMIT 20'); + if ($query->rowCount() > 0) { + $xml->startElementNS('slims', 'digitals', null); + while ($attachment_d = $query->fetch()) { + // check member type privileges + if ($attachment_d['access_limit']) continue; + $xml->startElementNS('slims', 'digital_item', null); + $xml->writeAttribute('id', $attachment_d['file_id']); + $xml->writeAttribute('url', trim($attachment_d['file_url'])); + $xml->writeAttribute('path', $attachment_d['file_dir'] . '/' . $attachment_d['file_name']); + $xml->writeAttribute('mimetype', $attachment_d['mime_type']); + $xml->text($attachment_d['file_title']); + $xml->endElement(); // -- digital_item + } + $xml->endElement(); // -- digitals + } + } + + function toRSS() + { + // TODO: Implement toRSS() method. + } +} diff --git a/lib/SearchEngine/Engine.php b/lib/SearchEngine/Engine.php new file mode 100644 index 00000000..cd345792 --- /dev/null +++ b/lib/SearchEngine/Engine.php @@ -0,0 +1,52 @@ +engine[] = $class_name; + return $this; + } + + function get(): array + { + return $this->engine; + } +} \ No newline at end of file diff --git a/lib/SearchEngine/SearchBiblioEngine.php b/lib/SearchEngine/SearchBiblioEngine.php new file mode 100644 index 00000000..e55ea9a4 --- /dev/null +++ b/lib/SearchEngine/SearchBiblioEngine.php @@ -0,0 +1,422 @@ +buildSQL(); + + // execute query + $db = DB::getInstance(); + $count = $db->query($sql['count']); + $query = $db->query($sql['query']); + + // get results + $this->num_rows = ($count->fetch(\PDO::FETCH_NUM))[0] ?? 0; + $this->documents = $query->fetchAll(\PDO::FETCH_ASSOC); + + // end time + $end = microtime(true); + $this->query_time = round($end - $start, 5); + } + + function buildSQL() + { + $sql_select = 'select sb.biblio_id, sb.title, sb.author, sb.topic, sb.image, sb.isbn_issn, sb.publisher, sb.publish_place, sb.publish_year, sb.labels, sb.input_date'; + + // checking custom front page fields file + $file_path = SB; + $file_path .= config('template.dir', 'template') . DS; + $file_path .= config('template.theme', 'default') . DS; + $file_path .= 'custom_frontpage_record.inc.php'; + if (file_exists($file_path)) { + include $file_path; + $this->custom_fields = $custom_fields ?? []; + foreach ($this->custom_fields as $field => $field_opts) { + if ($field_opts[0] == 1 && !in_array($field, array('availability', 'isbn_issn'))) { + $sql_select .= ", sb.$field"; + } + } + } + + $sql_criteria = 'where sb.opac_hide=0 '; + $sql_criteria .= ($c = $this->buildCriteria($this->criteria)) !== '' ? 'and (' . $c . ') ' : ''; + + $sql_query = $sql_select . ' from search_biblio as sb ' . $sql_criteria . ' order by sb.last_update desc limit ' . $this->limit . ' offset ' . $this->offset; + $sql_count = 'select count(sb.biblio_id)' . ' from search_biblio as sb ' . $sql_criteria; + + return [ + 'count' => $sql_count, + 'query' => $sql_query + ]; + } + + function buildCriteria() + { + $boolean = ''; + $sql_criteria = ''; + foreach ($this->criteria->toCQLToken($this->stop_words) as $token) { + $field = $token['f']; + + $is_phrase = isset($token['is_phrase']); + + // break the loop if we meet cql_end field + if ($field === 'cql_end') break; + + // boolean mode + if ($field == 'boolean') { + if ($token['b'] == '*') { + $boolean = 'or'; + } else { + $boolean = 'and'; + } + continue; + } else { + if ($boolean) { + $sql_criteria .= " $boolean "; + } else { + if ($token['b'] == '*') { + $sql_criteria .= " or "; + } else { + $sql_criteria .= " and "; + } + } + $bool = $token['b']; + $query = $token['q']; + if (in_array($field, array('title', 'author', 'subject', 'notes'))) { + $query = '+' . ($is_phrase ? '"' . $query . '"' : $query); + if (!$is_phrase) { + $query = preg_replace('@\s+@i', ' +', $query); + } + } + $boolean = ''; + } + + // check fields + switch ($field) { + case 'author': + if ($bool == '-') { + $sql_criteria .= " not (match (sb.author) against ('$query' in boolean mode))"; + } else { + $sql_criteria .= " (match (sb.author) against ('$query' in boolean mode))"; + } + break; + case 'subject': + if ($bool == '-') { + $sql_criteria .= " not (match (sb.topic) against ('$query' in boolean mode))"; + } else { + $sql_criteria .= " (match (sb.topic) against ('$query' in boolean mode))"; + } + break; + case 'location': + if (!$this->disable_item_data) { + if ($bool == '-') { + $sql_criteria .= " not (match (sb.location) against ('$query' in boolean mode))"; + } else { + $sql_criteria .= " (match (sb.location) against ('$query' in boolean mode))"; + } + } else { + if ($bool == '-') { + $sql_criteria .= " sb.node !='$query'"; + } else { + $sql_criteria .= " sb.node = '$query'"; + } + } + break; + case 'colltype': + if (!$this->disable_item_data) { + if ($bool == '-') { + $sql_criteria .= " not (match (sb.collection_types) against ('$query' in boolean mode))"; + } else { + $sql_criteria .= " match (sb.collection_types) against ('$query' in boolean mode)"; + } + } + break; + case 'itemcode': + if (!$this->disable_item_data) { + if ($bool == '-') { + $sql_criteria .= " not (match (sb.items) against ('$query' in boolean mode))"; + } else { + $sql_criteria .= " match (sb.items) against ('$query' in boolean mode)"; + } + } + break; + case 'callnumber': + if ($bool == '-') { + $sql_criteria .= ' biblio.call_number not LIKE \'' . $query . '%\''; + } else { + $sql_criteria .= ' sb.call_number LIKE \'' . $query . '%\''; + } + break; + case 'itemcallnumber': + if (!$this->disable_item_data) { + if ($bool == '-') { + $sql_criteria .= ' item.call_number not LIKE \'' . $query . '%\''; + } else { + $sql_criteria .= ' item.call_number LIKE \'' . $query . '%\''; + } + } + break; + case 'class': + if ($bool == '-') { + $sql_criteria .= ' sb.classification not LIKE \'' . $query . '%\''; + } else { + $sql_criteria .= ' sb.classification LIKE \'' . $query . '%\''; + } + break; + case 'isbn': + if ($bool == '-') { + $sql_criteria .= ' sb.isbn_issn not LIKE \'' . $query . '%\''; + } else { + $sql_criteria .= ' sb.isbn_issn LIKE \'' . $query . '%\''; + } + break; + case 'publisher': + if ($bool == '-') { + $sql_criteria .= " sb.publisher!='$query'"; + } else { + $sql_criteria .= " sb.publisher LIKE '$query%'"; + } + break; + case 'publishyear': + if ($bool == '-') { + $sql_criteria .= ' sb.publish_year!=\'' . $query . '\''; + } else { + $sql_criteria .= ' sb.publish_year LIKE \'' . $query . '\''; + } + break; + case 'gmd': + if ($bool == '-') { + $sql_criteria .= " sb.gmd!='$query'"; + } else { + $sql_criteria .= " sb.gmd='$query'"; + } + break; + case 'notes': + if ($bool == '-') { + $sql_criteria .= " not (match (sb.notes) against ('" . $query . "' in boolean mode))"; + } else { + $sql_criteria .= " (match (sb.notes) against ('" . $query . "' in boolean mode))"; + } + break; + case 'opengroup': + $sql_criteria .= "("; + break; + case 'closegroup': + $sql_criteria .= ")"; + break; + default: + if ($bool == '-') { + $sql_criteria .= " not (match (sb.title, sb.series_title) against ('$query' in boolean mode))"; + } else { + $sql_criteria .= " (match (sb.title, sb.series_title) against ('$query' in boolean mode))"; + } + break; + } + } + return preg_replace('@^(AND|OR|NOT)\s*|\s+(AND|OR|NOT)$@i', '', trim($sql_criteria)); + } + + function toArray() + { + // TODO: Implement toArray() method. + } + + function toJSON() + { + // TODO: Implement toJSON() method. + } + + function toHTML() + { + $buffer = ''; + // include biblio list html template callback + $path = SB . config('template.dir', 'template') . DS; + $path .= config('template.theme', 'default') . DS . 'biblio_list_template.php'; + include $path; + + foreach ($this->documents as $i => $document) { + $buffer .= \biblio_list_format(DB::getInstance('mysqli'), $document, $i, [ + 'keywords' => $this->criteria->keywords, + 'enable_custom_frontpage' => true, + 'custom_fields' => $this->custom_fields + ]); + } + return $buffer; + } + + function toXML() + { + $xml = new \XMLWriter(); + $xml->openMemory(); + $xml->setIndent(true); + $xml->startElement('modsCollection'); + $xml->writeAttribute('xmlns:xlink', 'http://www.w3.org/1999/xlink'); + $xml->writeAttribute('xmlns:xsi', 'http://www.w3.org/2001/XMLSchema-instance'); + $xml->writeAttribute('xmlns', 'http://www.loc.gov/mods/v3'); + $xml->writeAttribute('xmlns:slims', 'http://slims.web.id'); + $xml->writeAttribute('xsi:schemaLocation', 'http://www.loc.gov/mods/v3 http://www.loc.gov/standards/mods/v3/mods-3-3.xsd'); + + $xml->startElementNS('slims', 'resultInfo', null); + $xml->startElementNS('slims', 'modsResultNum', null); + $xml->text($this->num_rows); + $xml->endElement(); // -- modsResultNum + $xml->startElementNS('slims', 'modsResultPage', null); + $xml->text($this->page); + $xml->endElement(); // -- modsResultPage + $xml->startElementNS('slims', 'modsResultShowed', null); + $xml->text($this->limit); + $xml->endElement(); // -- modsResultShowed + $xml->endElement(); // -- resultInfo + + foreach ($this->documents as $document) { + $xml->startElement('mods'); + $xml->writeAttribute('version', '3.3'); + $xml->writeAttribute('ID', $document['biblio_id']); + + // parsing title + $title_main = $document['title']; + $title_sub = ''; + if (stripos($document['title'], '/') !== false) { + $title_main = trim(substr_replace($document['title'], '', stripos($document['title'], '/') + 1)); + } + if (stripos($document['title'], ':') !== false) { + $title_main = trim(substr_replace($document['title'], '', stripos($document['title'], ':') + 1)); + $title_sub = trim(substr_replace($document['title'], '', 0, stripos($document['title'], ':') + 1)); + } + if (stripos($title_sub, '/') !== false) { + $title_sub = trim(substr_replace($title_sub, '', stripos($title_sub, '/') + 1)); + } + + $xml->startElement('titleInfo'); + $xml->startElement('title'); + $xml->text($title_main); + $xml->endElement(); // -- title + if ($title_sub !== '') { + $xml->startElement('subTitle'); + $xml->text($title_sub); + $xml->endElement(); // -- subTitle + } + $xml->endElement(); // -- titleInfo + + // authors + $this->xmlAuthor($xml, $document['biblio_id']); + + $xml->startElement('typeOfResource'); + $xml->writeAttribute('collection', 'yes'); + $xml->text('mixed material'); + $xml->endElement(); // -- typeOfResource + $xml->startElement('identifier'); + $xml->writeAttribute('type', 'isbn'); + $xml->text(str_replace(array('-', ' '), '', $document['isbn_issn'])); + $xml->endElement(); // -- identifier + + $xml->startElement('originInfo'); + $xml->startElement('place'); + $xml->startElement('placeTerm'); + $xml->writeAttribute('type', 'text'); + $xml->text($document['publish_place']); + $xml->endElement(); // -- placeTerm + $xml->startElement('publisher'); + $xml->text($document['publisher']); + $xml->endElement(); // -- publisher + $xml->startElement('dateIssued'); + $xml->text($document['publish_year']); + $xml->endElement(); // -- dateIssued + $xml->endElement(); // -- place + $xml->endElement(); // -- originInfo + + // digital file + $this->xmlAttachment($xml, $document['biblio_id']); + + // images + if (!empty($document['image'])) { + $xml->startElementNS('slims', 'image', null); + $xml->text(urlencode($document['image'])); + $xml->endElement(); + } + + $xml->endElement(); // -- mods + } + + $xml->endElement(); // -- modsCollection + + return $xml->flush(); + } + + function xmlAuthor(&$xml, $biblio_id) + { + $query = DB::getInstance()->query('SELECT a.*,ba.level FROM mst_author AS a' + . ' LEFT JOIN biblio_author AS ba ON a.author_id=ba.author_id WHERE ba.biblio_id=' . $biblio_id); + while ($author = $query->fetch()) { + $xml->startElement('name'); + $xml->writeAttribute('type', config('authority_type')[$author['authority_type']] ?? ''); + $xml->writeAttribute('authority', $author['auth_list']); + $xml->startElement('namePart'); + $xml->text($author['author_name']); + $xml->endElement(); // -- namePart + $xml->startElement('role'); + $xml->startElement('roleTerm'); + $xml->writeAttribute('type', 'text'); + $xml->text(config('authority_level')[$author['level']] ?? ''); + $xml->endElement(); // -- roleTerm + $xml->endElement(); // -- role + $xml->endElement(); // -- name + } + } + + function xmlAttachment(&$xml, $biblio_id) + { + $query = DB::getInstance()->query('SELECT att.*, f.* FROM biblio_attachment AS att + LEFT JOIN files AS f ON att.file_id=f.file_id WHERE att.biblio_id=' . $biblio_id . ' AND att.access_type=\'public\' LIMIT 20'); + if ($query->rowCount() > 0) { + $xml->startElementNS('slims', 'digitals', null); + while ($attachment_d = $query->fetch()) { + // check member type privileges + if ($attachment_d['access_limit']) continue; + $xml->startElementNS('slims', 'digital_item', null); + $xml->writeAttribute('id', $attachment_d['file_id']); + $xml->writeAttribute('url', trim($attachment_d['file_url'])); + $xml->writeAttribute('path', $attachment_d['file_dir'] . '/' . $attachment_d['file_name']); + $xml->writeAttribute('mimetype', $attachment_d['mime_type']); + $xml->text($attachment_d['file_title']); + $xml->endElement(); // -- digital_item + } + $xml->endElement(); // -- digitals + } + } + + function toRSS() + { + // TODO: Implement toRSS() method. + } +} diff --git a/lib/autoload.php b/lib/autoload.php index 406265ef..a90f53ee 100644 --- a/lib/autoload.php +++ b/lib/autoload.php @@ -17,6 +17,12 @@ "Brick\\Math\\" => "/math/src/", "Ifsnop\\Mysqldump\\" => "/mysqldump-php/src/Ifsnop/Mysqldump/", "PHPMailer\\PHPMailer\\" => "/PHPMailer/src/", + "GuzzleHttp" => "/guzzlehttp/guzzle/src", + "GuzzleHttp\\Psr7\\" => "/guzzlehttp/psr7/src", + "GuzzleHttp\\Exception\\" => "/guzzle/src/", + "GuzzleHttp\Promise" => "/guzzlehttp/promises/src", + "Psr\\Http\\Message\\" => "/psr/http-message/src", + "Psr\\Http\\Client\\" => "/psr/http-client/src" ]; foreach ($namespaces as $namespace => $classpaths) { diff --git a/lib/comment.inc.php b/lib/comment.inc.php index 7ac49fbe..dae08614 100755 --- a/lib/comment.inc.php +++ b/lib/comment.inc.php @@ -60,7 +60,7 @@ function showComment($_detail_id) while ($_data = $commlist->fetch_assoc()) { $_list_comment .= '
'; $_list_comment .= '
'.$_data['member_name']. __(' at ') . $_data['input_date']. __(' write'). '
'; - $_list_comment .= '
'. $_data['comment'] . '
'; + $_list_comment .= '
'. $_data['comment'] . '
'; $_list_comment .= '
'; } $_list_comment .= '
'.simbio_paging::paging($_all_recs, $_recs_each_page, $int_pages_each_set = 10, '', '_self').'
'; diff --git a/lib/content.inc.php b/lib/content.inc.php index 45ddeef5..e85c666c 100755 --- a/lib/content.inc.php +++ b/lib/content.inc.php @@ -1,136 +1,136 @@ - 1) { - $offset = ($page*$max_each_page)-$max_each_page; - } - - // language - $_lang = strtolower($sysconf['default_lang']); - - // query content - $_sql_content = "SELECT SQL_CALC_FOUND_ROWS * FROM content WHERE is_news=1"; - if ($search_query) { - $search_query = $obj_db->escape_string(trim($search_query)); - $_sql_content .= " AND MATCH(`content_title`, `content_desc`) AGAINST('$search_query' IN BOOLEAN MODE)"; - } - $_sql_content .= " ORDER BY `last_update` DESC"; - $_sql_content .= " LIMIT $max_each_page OFFSET $offset"; - - $_content_q = $obj_db->query($_sql_content); - // echo $_sql_content; - - // get total rows - $_total_rows = $obj_db->query('SELECT FOUND_ROWS()'); - $_total_rows_d = $_total_rows->fetch_row(); - $total = $_total_rows_d[0]; - - // get content data - while ($_content_d = $_content_q->fetch_assoc()) { - $contents[] = $_content_d; - } - - return $contents; - } - - public function get($obj_db, $str_path = '') - { - global $sysconf; - $_path = strtolower(trim($str_path)); - if (!$_path) { - return; - } - - if (preg_match('@^admin.+@i', $_path)) { - $_unauthorized = !isset($_SESSION['uid']) AND !isset($_SESSION['uname']) AND !isset($_SESSION['realname']); - if ($_unauthorized) { - return; - } - } - - // language - $_lang = strtolower($sysconf['default_lang']); - $_path_lang = $_path.'_'.$_lang; - - // check for language - $_sql_check = sprintf('SELECT COUNT(*) FROM content WHERE content_path=\'%s\'', $obj_db->escape_string($_path_lang)); - $_check_q = $obj_db->query($_sql_check); - $_check_d = $_check_q->fetch_row(); - if ($_check_d[0] > 0) { - $_path = $_path_lang; - } - - // query content - $_sql_content = sprintf('SELECT * FROM content WHERE content_path=\'%s\'', $obj_db->escape_string($_path)); - $_content_q = $obj_db->query($_sql_content); - // get content data - $_content_d = $_content_q->fetch_assoc(); - if (!isset($_content_d['content_title']) OR !isset($_content_d['content_path'])) { - return false; - } else { - $_content['Title'] = $_content_d['content_title']; - $_content['Path'] = $_content_d['content_path']; - $_content['Content'] = $_content_d['content_desc']; - // strip html - if ($this->strip_html) { - $_content['Content'] = strip_tags($_content['Content'], $this->allowed_tags); - } - - return $_content; - } - } -} + 1) { + $offset = ($page*$max_each_page)-$max_each_page; + } + + // language + $_lang = strtolower($sysconf['default_lang']); + + // query content + $_sql_content = "SELECT SQL_CALC_FOUND_ROWS * FROM content WHERE is_news=1"; + if ($search_query) { + $search_query = $obj_db->escape_string(trim($search_query)); + $_sql_content .= " AND MATCH(`content_title`, `content_desc`) AGAINST('$search_query' IN BOOLEAN MODE)"; + } + $_sql_content .= " ORDER BY `last_update` DESC"; + $_sql_content .= " LIMIT $max_each_page OFFSET $offset"; + + $_content_q = $obj_db->query($_sql_content); + // echo $_sql_content; + + // get total rows + $_total_rows = $obj_db->query('SELECT FOUND_ROWS()'); + $_total_rows_d = $_total_rows->fetch_row(); + $total = $_total_rows_d[0]; + + // get content data + while ($_content_d = $_content_q->fetch_assoc()) { + $contents[] = $_content_d; + } + + return $contents; + } + + public function get($obj_db, $str_path = '') + { + global $sysconf; + $_path = strtolower(trim($str_path)); + if (!$_path) { + return; + } + + if (preg_match('@^admin.+@i', $_path)) { + $_unauthorized = !isset($_SESSION['uid']) AND !isset($_SESSION['uname']) AND !isset($_SESSION['realname']); + if ($_unauthorized) { + return; + } + } + + // language + $_lang = strtolower($sysconf['default_lang']); + $_path_lang = $_path.'_'.$_lang; + + // check for language + $_sql_check = sprintf('SELECT COUNT(*) FROM content WHERE content_path=\'%s\'', $obj_db->escape_string($_path_lang)); + $_check_q = $obj_db->query($_sql_check); + $_check_d = $_check_q->fetch_row(); + if ($_check_d[0] > 0) { + $_path = $_path_lang; + } + + // query content + $_sql_content = sprintf('SELECT * FROM content WHERE content_path=\'%s\'', $obj_db->escape_string($_path)); + $_content_q = $obj_db->query($_sql_content); + // get content data + $_content_d = $_content_q->fetch_assoc(); + if (!isset($_content_d['content_title']) OR !isset($_content_d['content_path'])) { + return false; + } else { + $_content['Title'] = $_content_d['content_title']; + $_content['Path'] = $_content_d['content_path']; + $_content['Content'] = $_content_d['content_desc']; + // strip html + if ($this->strip_html) { + $_content['Content'] = strip_tags($_content['Content'], $this->allowed_tags); + } + + return $_content; + } + } +} diff --git a/lib/contents/default.inc.php b/lib/contents/default.inc.php old mode 100755 new mode 100644 index 8c93bd0f..ae3205c5 --- a/lib/contents/default.inc.php +++ b/lib/contents/default.inc.php @@ -1,299 +1,109 @@ getMessage()); -} - -if (isset($sysconf['enable_xml_detail']) && !$sysconf['enable_xml_detail']) { - $biblio_list->xml_detail = false; -} -if (isset($sysconf['enable_mark']) && !$sysconf['enable_mark']) { - $biblio_list->enable_mark = false; -} - -// search result info -$search_result_info = ''; + * @Created by : Waris Agung Widodo (ido.alit@gmail.com) + * @Date : 01/01/2022 12:14 + * @File name : default.inc.php + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + * + */ + +use SLiMS\SearchEngine\Contract; +use SLiMS\SearchEngine\Criteria; +use SLiMS\SearchEngine\DefaultEngine; // if we are in searching mode -if (isset($_GET['search']) && !empty($_GET['search'])) { - // default vars - $is_adv = false; - $keywords = ''; - $criteria = ''; - // simple search - if (isset($_GET['keywords'])) { - $keywords = trim(strip_tags(urldecode($_GET['keywords']))); - } - if ($keywords && !preg_match('@[a-z0-9_.]+=[^=]+\s+@i', $keywords.' ')) { - $criteria = 'title='.$keywords.' OR author='.$keywords.' OR subject='.$keywords; - $biblio_list->setSQLcriteria($criteria); - } else { - $biblio_list->setSQLcriteria($keywords); - } - // advanced search - $is_adv = isset($_GET['title']) || isset($_GET['author']) || isset($_GET['isbn']) - || isset($_GET['subject']) || isset($_GET['location']) - || isset($_GET['gmd']) || isset($_GET['colltype']) || isset($_GET['publisher']) || isset($_GET['callnumber']); - if ($is_adv) { - $title = ''; - if (isset($_GET['title'])) { - $title = trim(strip_tags(urldecode($_GET['title']))); - } - $author = ''; - if (isset($_GET['author'])) { - $author = trim(strip_tags(urldecode($_GET['author']))); - } - $subject = ''; - if (isset($_GET['subject'])) { - $subject = trim(strip_tags(urldecode($_GET['subject']))); - } - $isbn = ''; - if (isset($_GET['isbn'])) { - $isbn = trim(strip_tags(urldecode($_GET['isbn']))); - } - $gmd = ''; - if (isset($_GET['gmd'])) { - $gmd = trim(strip_tags(urldecode($_GET['gmd']))); - } - $colltype = ''; - if (isset($_GET['colltype'])) { - $colltype = trim(strip_tags(urldecode($_GET['colltype']))); - } - $location = ''; - if (isset($_GET['location'])) { - $location = trim(strip_tags(urldecode($_GET['location']))); - } - $publisher = ''; - if (isset($_GET['publisher'])) { - $publisher = trim(strip_tags(urldecode($_GET['publisher']))); - } - $callnumber = ''; - if (isset($_GET['callnumber'])) { - $callnumber = trim(strip_tags(urldecode($_GET['callnumber']))); - } - // don't do search if all search field is empty - if ($title || $author || $subject || $isbn || $gmd || $colltype || $location || $publisher || $callnumber !== '') { - $criteria = ''; - if ($title) { $criteria .= ' title='.$title; } - if ($author) { $criteria .= ' author='.$author; } - if ($subject) { $criteria .= ' subject='.$subject; } - if ($isbn) { $criteria .= ' isbn='.$isbn; } - if ($gmd) { $criteria .= ' gmd="'.$gmd.'"'; } - if ($colltype) { $criteria .= ' colltype="'.$colltype.'"'; } - if ($location) { $criteria .= ' location="'.$location.'"'; } - if ($publisher) { $criteria .= ' publisher="'.$publisher.'"'; } - if ($callnumber !== '') { $criteria .= ' callnumber="'.$callnumber.'"'; } - $criteria = trim($criteria); - $biblio_list->setSQLcriteria($criteria); - } - } - - // searched words - $searched_words = implode(' ', $biblio_list->words); - if ($biblio_list->words) { - $searched_words_js_array = '['; - foreach($biblio_list->words as $word) { - $searched_words_js_array .= "'$word',"; - } - $searched_words_js_array = substr_replace($searched_words_js_array, '', -1); - $searched_words_js_array .= ']'; - } - - // search result info construction - $keywords_info = ''.((strlen($keywords)>30)?substr($keywords, 0, 30).'...':$keywords).''; - $search_result_info .= '
'; - if ($is_adv) { - $search_result_info .= __('Found {biblio_list->num_rows} from your keywords').': '.$keywords_info.' '; - if ($title) { $search_result_info .= __('Title').' : '.$title.', '; } - if ($author) { $search_result_info .= __('Author').' : '.$author.', '; } - if ($subject) { $search_result_info .= __('Subject').' : '.$subject.', '; } - if ($isbn) { $search_result_info .= __('ISBN/ISSN').' : '.$isbn.', '; } - if ($gmd) { $search_result_info .= __('GMD').' : '.$gmd.', '; } - if ($colltype) { $search_result_info .= __('Collection Type').' : '.$colltype.', '; } - if ($location) { $search_result_info .= __('Location').' : '.$location.', '; } - if ($publisher) { $search_result_info .= __('Publisher').' : '.$publisher.', '; } - if ($callnumber !== '') { $search_result_info .= __('Call Number').' : '.$callnumber.', '; } - // strip last comma - $search_result_info = substr_replace($search_result_info, '', -2); - } else { - $search_result_info .= __('Found {biblio_list->num_rows} from your keywords').': '.$keywords_info.''; - } - $search_result_info .= '
'; - - // show promoted titles - if (isset($sysconf['enable_promote_titles']) && $sysconf['enable_promote_titles']) { - $biblio_list->only_promoted = true; - } - - if (!isset($_GET['resultXML']) && !isset($_GET['JSONLD']) && !isset($_GET['rss'])) { - // show the list - echo $biblio_list->getDocumentList(); - echo '
'."\n"; - } - - // set result number info - $search_result_info = str_replace('{biblio_list->num_rows}', $biblio_list->num_rows, $search_result_info); - - // count total pages - $total_pages = ceil($biblio_list->num_rows/$sysconf['opac_result_num']); - - // page number info - if (isset($_GET['page']) AND $_GET['page'] > 1) { - $page = intval($_GET['page']); - $msg = str_replace('{page}', $page, __('You currently on page {page} of {total_pages} page(s)')); //mfc - $msg = str_replace('{total_pages}', $total_pages, $msg); - $search_result_info .= '
'.$msg.'
'; - } else { - $page = 1; - } - - // query time - if (!isset($_SERVER['QUERY_STRING'])) { - $_SERVER['QUERY_STRING'] = ''; - } - $search_result_info .= '
'.__('Query took').' '.$biblio_list->query_time.' '.__('second(s) to complete').'
'; - if ($biblio_list->num_rows < 1 && $keywords != '') { - // word suggestion with enchant - if (function_exists('enchant_broker_init') && $sysconf['spellchecker_enabled']) { - $enc = enchant_broker_init(); - if (enchant_broker_dict_exists($enc,$sysconf['default_lang'])) { - $dict = enchant_broker_request_dict($enc,$sysconf['default_lang']); - } else { - $dict = enchant_broker_request_dict($enc,'en_US'); - } - $search_result_info .= '
'.__('Did you mean:').' '; - $word = strtok($keywords, " \t\n"); - $keywords_suggest = array(); - while ($word !== false) { - // check if we are inside quote - if (stripos($word, '"', 0) === true) { - $search_result_info .= preg_replace('@[a-z]@i', '', $word); - $word = str_replace('"', '', $word); - } - $wordcorrect = enchant_dict_check($dict, $word); - if (!$wordcorrect) { - $closest = null; - $wordsuggest = enchant_dict_suggest($dict, $word); - $shortest = -1; - // loop through words to find the closest with levenshtein - foreach ($wordsuggest as $wordsg) { - $lev = levenshtein($word, $wordsg); - if ($lev == 0) { - $closest = $wordsg; - $shortest = 0; - break; - } - - if ($lev <= $shortest || $shortest < 0) { - // set the closest match, and shortest distance - $closest = $wordsg; - $shortest = $lev; - } - } - - $keywords_suggest[] = ''.$closest.''; - $keywords_suggest_plain[] = $closest; +if (isset($_GET['search'])) { + // required library + require SIMBIO . 'simbio_GUI/paging/simbio_paging.inc.php'; + require LIB . 'biblio_list_model.inc.php'; + + // initialize variable + $keywords = ''; + $search_result_info = ''; + + // get engine name from setting + $search_engine = config('search_engine', DefaultEngine::class); + + // starting engine + $engine = new $search_engine; + + // make sure the engine running is the correct engine + if ($engine instanceof Contract) { + // opac limit result + $engine->setLimit(config('opac_result_num', 10)); + + // initialize criteria + $criteria = new Criteria; + $searched_fields = array_intersect($engine->searchable_fields, array_keys($_GET)); + if (!empty($searched_fields)) { + // get criteria from advanced search + foreach ($searched_fields as $field) { + $value = trim(strip_tags(urldecode($_GET[$field]))); + if ($value !== '' && $value !== '0') $criteria->and($field, $value); + } + $keywords = $criteria->getQueries(); } else { - $keywords_suggest[] = ''.$word.''; - $keywords_suggest_plain[] = $word; - } - $word = strtok(" \t\n"); - } - $keywords_suggest_plain_str = implode(' ', $keywords_suggest_plain); - $search_result_info .= ''; - $search_result_info .= implode(' ', $keywords_suggest); - $search_result_info .= '?
'; - enchant_broker_free_dict($dict); - } - } - - if (isset($biblio_list) && isset($sysconf['enable_xml_result']) && $sysconf['enable_xml_result']) { - $search_result_info .= '
'; - $search_result_info .= 'XML Result'; - $search_result_info .= 'JSON Result'; - $search_result_info .= '
'; - } -} - -if (isset($_GET['JSONLD']) && $sysconf['jsonld_result']) { - // get document list but don't output the result - $biblio_list->getDocumentList(false); - if ($biblio_list->num_rows > 0) { - // send http header - header('Content-Type: application/ld+json'); - header('Content-disposition: attachment; filename=biblio-opac.json'); - echo $biblio_list->JSONLDresult(); - } - exit(); -} -// check if we are on xml resultset mode -if ( (isset($_GET['rss']) || isset($_GET['resultXML'])) && $sysconf['enable_xml_result']) { - // get document list but don't output the result - $biblio_list->getDocumentList(false); - if ($biblio_list->num_rows > 0) { - // send http header - header('Content-Type: text/xml'); - echo ''."\n"; - if (isset($_GET['rss'])) { - echo $biblio_list->RSSresult(); - } else { - echo $biblio_list->XMLresult(); + // get criteria from simple search + $keywords = trim(strip_tags(urldecode($_GET['keywords'] ?? ''))); + if ($keywords !== '') $criteria->keywords = $keywords; + } + + // get records base on criteria + $engine->setCriteria($criteria); + $engine->getDocuments(); + + // create output + // check if we are on json-ld result set mode + if (isset($_GET['JSONLD']) && config('jsonld_result')) { + // send http header + header('Content-Type: application/ld+json'); + header('Content-disposition: attachment; filename=biblio-opac.json'); + echo $engine->toJSON(); + exit(); + } else + // check if we are on xml result set mode + if ((isset($_GET['rss']) || isset($_GET['resultXML'])) && config('enable_xml_result')) { + // send http header + header('Content-Type: text/xml'); + echo '' . "\n"; + if (isset($_GET['rss'])) { + echo $engine->toRSS(); + } else { + echo $engine->toXML(); + } + exit(); + } else { + // default to HTML mode + // generate search result info + $keywords_info = '' . ((strlen($keywords) > 30) ? substr($keywords, 0, 30) . '...' : $keywords) . ''; + $search_result_info .= '
'; + $search_result_info .= __('Found {biblio_list->num_rows} from your keywords') . ': ' . $keywords_info . ''; + $search_result_info .= '
'; + $search_result_info = str_replace('{biblio_list->num_rows}', $engine->getNumRows(), $search_result_info); + $search_result_info .= '
' . __('Query took') . ' ' . $engine->query_time . ' ' . __('second(s) to complete') . '
'; + $search_result_info .= '
'; + $search_result_info .= 'XML Result'; + $search_result_info .= 'JSON Result'; + $search_result_info .= '
'; + + // pagination + $paging = simbio_paging::paging($engine->getNumRows(), $engine->getLimit(), '5'); + if ($paging) echo '
' . $paging . '
'; + echo '
' . $engine->toHTML() . '
'; + if ($paging) echo '
' . $paging . '
'; + } } - } - exit(); -} +} \ No newline at end of file diff --git a/lib/contents/fstream.inc.php b/lib/contents/fstream.inc.php index b2046f3e..8e02563c 100755 --- a/lib/contents/fstream.inc.php +++ b/lib/contents/fstream.inc.php @@ -18,6 +18,8 @@ * */ +use Ramsey\Uuid\Uuid; + // be sure that this file not accessed directly if (!defined('INDEX_AUTH')) { die("can not access this file directly"); @@ -25,6 +27,11 @@ die("can not access this file directly"); } +if (isset($_POST['init'])) { + echo base64_encode($_SESSION[$_POST['init']].$_POST['init']) ?? ''; + exit; +} + /* File Viewer */ // get file ID @@ -66,6 +73,9 @@ if ($file_d['mime_type'] == 'application/pdf') { if ($sysconf['pdf']['viewer'] == 'pdfjs') { $file_loc_url = SWB . 'index.php?p=fstream-pdf&fid=' . $fileID . '&bid=' . $biblioID; + $uuid = Uuid::uuid4()->toString(); + $_SESSION[$uuid] = base64_encode($file_d['file_key']); + $loader_init = $uuid; \SLiMS\Plugins::getInstance()->execute('fstream_pdf_before_download', ['data' => array('fileID' => $fileID, 'memberID' => $memberID, 'userID' => $userID, 'biblioID' => $biblioID, 'file_d' => $file_d)]); if (utility::isMobileBrowser()) { diff --git a/lib/contents/login.inc.php b/lib/contents/login.inc.php index 6dfd6b90..572b8c81 100755 --- a/lib/contents/login.inc.php +++ b/lib/contents/login.inc.php @@ -140,7 +140,7 @@ // message $msg = ''; simbio_security::destroySessionCookie($msg, COOKIES_NAME, SWB.'admin', false); } diff --git a/lib/contents/member.inc.php b/lib/contents/member.inc.php index ae381a27..83507db1 100644 --- a/lib/contents/member.inc.php +++ b/lib/contents/member.inc.php @@ -119,7 +119,7 @@ if ($logon->valid($dbs)) { // write log utility::writeLogs($dbs, 'member', $username, 'Login', sprintf(__('Login success for member %s from address %s'),$username,$_SERVER['REMOTE_ADDR'])); - if (isset($_GET['destination'])) { + if (isset($_GET['destination']) && filter_var($_GET['destination'], FILTER_VALIDATE_URL)) { header("location:" . $_GET['destination']); } else { header('Location: index.php?p=member'); @@ -209,7 +209,12 @@ if ($is_member_login) : - $member_image = $_SESSION['m_image'] && file_exists(IMGBS . 'persons/' . $_SESSION['m_image']) ? $_SESSION['m_image'] : 'person.png'; + if (filter_var($_SESSION['m_image'], FILTER_VALIDATE_URL)) { + $member_image_url = $_SESSION['m_image']; + } else { + $member_image = $_SESSION['m_image'] && file_exists(IMGBS . 'persons/' . $_SESSION['m_image']) ? $_SESSION['m_image'] : 'person.png'; + $member_image_url = './images/persons/' . $member_image; + } // require file require SIMBIO . 'simbio_GUI/table/simbio_table.inc.php'; @@ -706,7 +711,7 @@ function _isAlreadyReserved($dbs, $biblio_id)
- member photo + member photo
@@ -902,7 +907,7 @@ class="fas fa-sign-out-alt mr-2"> ?>
-
+
diff --git a/lib/contents/visitor.inc.php b/lib/contents/visitor.inc.php index 04153b9f..a30a5825 100755 --- a/lib/contents/visitor.inc.php +++ b/lib/contents/visitor.inc.php @@ -116,6 +116,8 @@ function setCounter($str_member_ID) { $_checkin_date = date('Y-m-d H:i:s'); $_checkin_sql = "INSERT INTO visitor_count (member_id, member_name, institution, checkin_date) VALUES ('$member_id', '$member_name', '$_institution', '$_checkin_date')"; + SLiMS\Plugins::getInstance()->execute('MEMBER_ON_VISIT', ['data' => $_d]); + // limitation if ($sysconf['enable_visitor_limitation']) { $already_checkin = checkVisit($member_id, true); @@ -138,6 +140,9 @@ function setCounter($str_member_ID) { return INSTITUTION_EMPTY; } else { $_checkin_sql = "INSERT INTO visitor_count (member_name, institution, checkin_date) VALUES ('$member_name', '$_institution', '$_checkin_date')"; + + SLiMS\Plugins::getInstance()->execute('NON_MEMBER_ON_VISIT', ['data' => ['member_name' => $member_name, 'institution' => $_institution]]); + // limitation if ($sysconf['enable_visitor_limitation']) { $already_checkin = checkVisit($member_name, false); @@ -158,17 +163,20 @@ function setCounter($str_member_ID) { $memberID = trim($_POST['memberID']); $counter = setCounter($memberID); if ($counter === true) { - echo $member_name . __(', thank you for inserting your data to our visitor log'); + $message = $member_name . __(', thank you for inserting your data to our visitor log'); if ($expire) { - echo '
'.__('Your membership already EXPIRED, please renew/extend your membership immediately').'
'; + $message = '
'.__('Your membership already EXPIRED, please renew/extend your membership immediately').'
'; } } else if ($counter === ALREADY_CHECKIN) { - echo __('Welcome back').' '.$member_name.'.'; + $message = __('Welcome back').' '.$member_name.'.'; } else if ($counter === INSTITUTION_EMPTY) { - echo __('Sorry, Please fill institution field if you are not library member'); + $message = __('Sorry, Please fill institution field if you are not library member'); } else { - echo __('Error inserting counter data to database!'); + $message = __('Error inserting counter data to database!'); } + + header('Content-Type: application/json'); + echo json_encode(['message' => $message, 'image' => $photo]); exit(); } @@ -190,6 +198,7 @@ function setCounter($str_member_ID) { $('#memberID').focus(); var visitorCounterForm = $('#visitorCounterForm'); var defaultMsg = $('#counterInfo').html(); + var defaultImg = 'photo.png'; // register event visitorCounterForm.on('submit', function(e) { e.preventDefault(); @@ -212,15 +221,16 @@ function setCounter($str_member_ID) { data: formData, cache: false, success: function(respond) { - $('#counterInfo').html(respond); - $('#text_voice').val(success_text + respond); + $('#counterInfo').html(respond.message); + $('#text_voice').val(success_text + respond.message); // reset counter setTimeout(function() { $('#speak').trigger('click'); - $('#visitorCounterPhoto').attr('src', './images/persons/photo.png'); + $('#visitorCounterPhoto').attr('src', `./images/persons/${respond.image}`); $('#counterInfo').html(defaultMsg); visitorCounterForm.enableForm().find('input[type=text]').val(''); $('#memberID').focus(); + setTimeout(() => { $('#visitorCounterPhoto').attr('src', `./images/persons/${defaultImg}`); }, 8000); }, 1000); }, complete: function() { @@ -251,8 +261,8 @@ function setCounter($str_member_ID) { message['volume'] = 1; message['rate'] = 1; message['pitch'] = 1; - message['lang'] = ''; - message['voice'] = voices[1]; + message['lang'] = ''; + message['voice'] = null; speechSynthesis.cancel(); speechSynthesis.speak(message); }); diff --git a/lib/guzzlehttp/guzzle/CHANGELOG.md b/lib/guzzlehttp/guzzle/CHANGELOG.md new file mode 100644 index 00000000..c3acb777 --- /dev/null +++ b/lib/guzzlehttp/guzzle/CHANGELOG.md @@ -0,0 +1,1479 @@ +# Change Log + +Please refer to [UPGRADING](UPGRADING.md) guide for upgrading to a major version. + +## 7.4.0 - 2021-10-18 + +### Added + +- Support PHP 8.1 [#2929](https://github.com/guzzle/guzzle/pull/2929), [#2939](https://github.com/guzzle/guzzle/pull/2939) +- Support `psr/log` version 2 and 3 [#2943](https://github.com/guzzle/guzzle/pull/2943) + +### Fixed + +- Make sure we always call `restore_error_handler()` [#2915](https://github.com/guzzle/guzzle/pull/2915) +- Fix progress parameter type compatibility between the cURL and stream handlers [#2936](https://github.com/guzzle/guzzle/pull/2936) +- Throw `InvalidArgumentException` when an incorrect `headers` array is provided [#2916](https://github.com/guzzle/guzzle/pull/2916), [#2942](https://github.com/guzzle/guzzle/pull/2942) + +### Changed + +- Be more strict with types [#2914](https://github.com/guzzle/guzzle/pull/2914), [#2917](https://github.com/guzzle/guzzle/pull/2917), [#2919](https://github.com/guzzle/guzzle/pull/2919), [#2945](https://github.com/guzzle/guzzle/pull/2945) + +## 7.3.0 - 2021-03-23 + +### Added + +- Support for DER and P12 certificates [#2413](https://github.com/guzzle/guzzle/pull/2413) +- Support the cURL (http://) scheme for StreamHandler proxies [#2850](https://github.com/guzzle/guzzle/pull/2850) +- Support for `guzzlehttp/psr7:^2.0` [#2878](https://github.com/guzzle/guzzle/pull/2878) + +### Fixed + +- Handle exceptions on invalid header consistently between PHP versions and handlers [#2872](https://github.com/guzzle/guzzle/pull/2872) + +## 7.2.0 - 2020-10-10 + +### Added + +- Support for PHP 8 [#2712](https://github.com/guzzle/guzzle/pull/2712), [#2715](https://github.com/guzzle/guzzle/pull/2715), [#2789](https://github.com/guzzle/guzzle/pull/2789) +- Support passing a body summarizer to the http errors middleware [#2795](https://github.com/guzzle/guzzle/pull/2795) + +### Fixed + +- Handle exceptions during response creation [#2591](https://github.com/guzzle/guzzle/pull/2591) +- Fix CURLOPT_ENCODING not to be overwritten [#2595](https://github.com/guzzle/guzzle/pull/2595) +- Make sure the Request always has a body object [#2804](https://github.com/guzzle/guzzle/pull/2804) + +### Changed + +- The `TooManyRedirectsException` has a response [#2660](https://github.com/guzzle/guzzle/pull/2660) +- Avoid "functions" from dependencies [#2712](https://github.com/guzzle/guzzle/pull/2712) + +### Deprecated + +- Using environment variable GUZZLE_CURL_SELECT_TIMEOUT [#2786](https://github.com/guzzle/guzzle/pull/2786) + +## 7.1.1 - 2020-09-30 + +### Fixed + +- Incorrect EOF detection for response body streams on Windows. + +### Changed + +- We dont connect curl `sink` on HEAD requests. +- Removed some PHP 5 workarounds + +## 7.1.0 - 2020-09-22 + +### Added + +- `GuzzleHttp\MessageFormatterInterface` + +### Fixed + +- Fixed issue that caused cookies with no value not to be stored. +- On redirects, we allow all safe methods like GET, HEAD and OPTIONS. +- Fixed logging on empty responses. +- Make sure MessageFormatter::format returns string + +### Deprecated + +- All functions in `GuzzleHttp` has been deprecated. Use static methods on `Utils` instead. +- `ClientInterface::getConfig()` +- `Client::getConfig()` +- `Client::__call()` +- `Utils::defaultCaBundle()` +- `CurlFactory::LOW_CURL_VERSION_NUMBER` + +## 7.0.1 - 2020-06-27 + +* Fix multiply defined functions fatal error [#2699](https://github.com/guzzle/guzzle/pull/2699) + +## 7.0.0 - 2020-06-27 + +No changes since 7.0.0-rc1. + +## 7.0.0-rc1 - 2020-06-15 + +### Changed + +* Use error level for logging errors in Middleware [#2629](https://github.com/guzzle/guzzle/pull/2629) +* Disabled IDN support by default and require ext-intl to use it [#2675](https://github.com/guzzle/guzzle/pull/2675) + +## 7.0.0-beta2 - 2020-05-25 + +### Added + +* Using `Utils` class instead of functions in the `GuzzleHttp` namespace. [#2546](https://github.com/guzzle/guzzle/pull/2546) +* `ClientInterface::MAJOR_VERSION` [#2583](https://github.com/guzzle/guzzle/pull/2583) + +### Changed + +* Avoid the `getenv` function when unsafe [#2531](https://github.com/guzzle/guzzle/pull/2531) +* Added real client methods [#2529](https://github.com/guzzle/guzzle/pull/2529) +* Avoid functions due to global install conflicts [#2546](https://github.com/guzzle/guzzle/pull/2546) +* Use Symfony intl-idn polyfill [#2550](https://github.com/guzzle/guzzle/pull/2550) +* Adding methods for HTTP verbs like `Client::get()`, `Client::head()`, `Client::patch()` etc [#2529](https://github.com/guzzle/guzzle/pull/2529) +* `ConnectException` extends `TransferException` [#2541](https://github.com/guzzle/guzzle/pull/2541) +* Updated the default User Agent to "GuzzleHttp/7" [#2654](https://github.com/guzzle/guzzle/pull/2654) + +### Fixed + +* Various intl icu issues [#2626](https://github.com/guzzle/guzzle/pull/2626) + +### Removed + +* Pool option `pool_size` [#2528](https://github.com/guzzle/guzzle/pull/2528) + +## 7.0.0-beta1 - 2019-12-30 + +The diff might look very big but 95% of Guzzle users will be able to upgrade without modification. +Please see [the upgrade document](UPGRADING.md) that describes all BC breaking changes. + +### Added + +* Implement PSR-18 and dropped PHP 5 support [#2421](https://github.com/guzzle/guzzle/pull/2421) [#2474](https://github.com/guzzle/guzzle/pull/2474) +* PHP 7 types [#2442](https://github.com/guzzle/guzzle/pull/2442) [#2449](https://github.com/guzzle/guzzle/pull/2449) [#2466](https://github.com/guzzle/guzzle/pull/2466) [#2497](https://github.com/guzzle/guzzle/pull/2497) [#2499](https://github.com/guzzle/guzzle/pull/2499) +* IDN support for redirects [2424](https://github.com/guzzle/guzzle/pull/2424) + +### Changed + +* Dont allow passing null as third argument to `BadResponseException::__construct()` [#2427](https://github.com/guzzle/guzzle/pull/2427) +* Use SAPI constant instead of method call [#2450](https://github.com/guzzle/guzzle/pull/2450) +* Use native function invocation [#2444](https://github.com/guzzle/guzzle/pull/2444) +* Better defaults for PHP installations with old ICU lib [2454](https://github.com/guzzle/guzzle/pull/2454) +* Added visibility to all constants [#2462](https://github.com/guzzle/guzzle/pull/2462) +* Dont allow passing `null` as URI to `Client::request()` and `Client::requestAsync()` [#2461](https://github.com/guzzle/guzzle/pull/2461) +* Widen the exception argument to throwable [#2495](https://github.com/guzzle/guzzle/pull/2495) + +### Fixed + +* Logging when Promise rejected with a string [#2311](https://github.com/guzzle/guzzle/pull/2311) + +### Removed + +* Class `SeekException` [#2162](https://github.com/guzzle/guzzle/pull/2162) +* `RequestException::getResponseBodySummary()` [#2425](https://github.com/guzzle/guzzle/pull/2425) +* `CookieJar::getCookieValue()` [#2433](https://github.com/guzzle/guzzle/pull/2433) +* `uri_template()` and `UriTemplate` [#2440](https://github.com/guzzle/guzzle/pull/2440) +* Request options `save_to` and `exceptions` [#2464](https://github.com/guzzle/guzzle/pull/2464) + +## 6.5.2 - 2019-12-23 + +* idn_to_ascii() fix for old PHP versions [#2489](https://github.com/guzzle/guzzle/pull/2489) + +## 6.5.1 - 2019-12-21 + +* Better defaults for PHP installations with old ICU lib [#2454](https://github.com/guzzle/guzzle/pull/2454) +* IDN support for redirects [#2424](https://github.com/guzzle/guzzle/pull/2424) + +## 6.5.0 - 2019-12-07 + +* Improvement: Added support for reset internal queue in MockHandler. [#2143](https://github.com/guzzle/guzzle/pull/2143) +* Improvement: Added support to pass arbitrary options to `curl_multi_init`. [#2287](https://github.com/guzzle/guzzle/pull/2287) +* Fix: Gracefully handle passing `null` to the `header` option. [#2132](https://github.com/guzzle/guzzle/pull/2132) +* Fix: `RetryMiddleware` did not do exponential delay between retires due unit mismatch. [#2132](https://github.com/guzzle/guzzle/pull/2132) +* Fix: Prevent undefined offset when using array for ssl_key options. [#2348](https://github.com/guzzle/guzzle/pull/2348) +* Deprecated `ClientInterface::VERSION` + +## 6.4.1 - 2019-10-23 + +* No `guzzle.phar` was created in 6.4.0 due expired API token. This release will fix that +* Added `parent::__construct()` to `FileCookieJar` and `SessionCookieJar` + +## 6.4.0 - 2019-10-23 + +* Improvement: Improved error messages when using curl < 7.21.2 [#2108](https://github.com/guzzle/guzzle/pull/2108) +* Fix: Test if response is readable before returning a summary in `RequestException::getResponseBodySummary()` [#2081](https://github.com/guzzle/guzzle/pull/2081) +* Fix: Add support for GUZZLE_CURL_SELECT_TIMEOUT environment variable [#2161](https://github.com/guzzle/guzzle/pull/2161) +* Improvement: Added `GuzzleHttp\Exception\InvalidArgumentException` [#2163](https://github.com/guzzle/guzzle/pull/2163) +* Improvement: Added `GuzzleHttp\_current_time()` to use `hrtime()` if that function exists. [#2242](https://github.com/guzzle/guzzle/pull/2242) +* Improvement: Added curl's `appconnect_time` in `TransferStats` [#2284](https://github.com/guzzle/guzzle/pull/2284) +* Improvement: Make GuzzleException extend Throwable wherever it's available [#2273](https://github.com/guzzle/guzzle/pull/2273) +* Fix: Prevent concurrent writes to file when saving `CookieJar` [#2335](https://github.com/guzzle/guzzle/pull/2335) +* Improvement: Update `MockHandler` so we can test transfer time [#2362](https://github.com/guzzle/guzzle/pull/2362) + +## 6.3.3 - 2018-04-22 + +* Fix: Default headers when decode_content is specified + + +## 6.3.2 - 2018-03-26 + +* Fix: Release process + + +## 6.3.1 - 2018-03-26 + +* Bug fix: Parsing 0 epoch expiry times in cookies [#2014](https://github.com/guzzle/guzzle/pull/2014) +* Improvement: Better ConnectException detection [#2012](https://github.com/guzzle/guzzle/pull/2012) +* Bug fix: Malformed domain that contains a "/" [#1999](https://github.com/guzzle/guzzle/pull/1999) +* Bug fix: Undefined offset when a cookie has no first key-value pair [#1998](https://github.com/guzzle/guzzle/pull/1998) +* Improvement: Support PHPUnit 6 [#1953](https://github.com/guzzle/guzzle/pull/1953) +* Bug fix: Support empty headers [#1915](https://github.com/guzzle/guzzle/pull/1915) +* Bug fix: Ignore case during header modifications [#1916](https://github.com/guzzle/guzzle/pull/1916) + ++ Minor code cleanups, documentation fixes and clarifications. + + +## 6.3.0 - 2017-06-22 + +* Feature: force IP resolution (ipv4 or ipv6) [#1608](https://github.com/guzzle/guzzle/pull/1608), [#1659](https://github.com/guzzle/guzzle/pull/1659) +* Improvement: Don't include summary in exception message when body is empty [#1621](https://github.com/guzzle/guzzle/pull/1621) +* Improvement: Handle `on_headers` option in MockHandler [#1580](https://github.com/guzzle/guzzle/pull/1580) +* Improvement: Added SUSE Linux CA path [#1609](https://github.com/guzzle/guzzle/issues/1609) +* Improvement: Use class reference for getting the name of the class instead of using hardcoded strings [#1641](https://github.com/guzzle/guzzle/pull/1641) +* Feature: Added `read_timeout` option [#1611](https://github.com/guzzle/guzzle/pull/1611) +* Bug fix: PHP 7.x fixes [#1685](https://github.com/guzzle/guzzle/pull/1685), [#1686](https://github.com/guzzle/guzzle/pull/1686), [#1811](https://github.com/guzzle/guzzle/pull/1811) +* Deprecation: BadResponseException instantiation without a response [#1642](https://github.com/guzzle/guzzle/pull/1642) +* Feature: Added NTLM auth [#1569](https://github.com/guzzle/guzzle/pull/1569) +* Feature: Track redirect HTTP status codes [#1711](https://github.com/guzzle/guzzle/pull/1711) +* Improvement: Check handler type during construction [#1745](https://github.com/guzzle/guzzle/pull/1745) +* Improvement: Always include the Content-Length if there's a body [#1721](https://github.com/guzzle/guzzle/pull/1721) +* Feature: Added convenience method to access a cookie by name [#1318](https://github.com/guzzle/guzzle/pull/1318) +* Bug fix: Fill `CURLOPT_CAPATH` and `CURLOPT_CAINFO` properly [#1684](https://github.com/guzzle/guzzle/pull/1684) +* Improvement: Use `\GuzzleHttp\Promise\rejection_for` function instead of object init [#1827](https://github.com/guzzle/guzzle/pull/1827) + + ++ Minor code cleanups, documentation fixes and clarifications. + +## 6.2.3 - 2017-02-28 + +* Fix deprecations with guzzle/psr7 version 1.4 + +## 6.2.2 - 2016-10-08 + +* Allow to pass nullable Response to delay callable +* Only add scheme when host is present +* Fix drain case where content-length is the literal string zero +* Obfuscate in-URL credentials in exceptions + +## 6.2.1 - 2016-07-18 + +* Address HTTP_PROXY security vulnerability, CVE-2016-5385: + https://httpoxy.org/ +* Fixing timeout bug with StreamHandler: + https://github.com/guzzle/guzzle/pull/1488 +* Only read up to `Content-Length` in PHP StreamHandler to avoid timeouts when + a server does not honor `Connection: close`. +* Ignore URI fragment when sending requests. + +## 6.2.0 - 2016-03-21 + +* Feature: added `GuzzleHttp\json_encode` and `GuzzleHttp\json_decode`. + https://github.com/guzzle/guzzle/pull/1389 +* Bug fix: Fix sleep calculation when waiting for delayed requests. + https://github.com/guzzle/guzzle/pull/1324 +* Feature: More flexible history containers. + https://github.com/guzzle/guzzle/pull/1373 +* Bug fix: defer sink stream opening in StreamHandler. + https://github.com/guzzle/guzzle/pull/1377 +* Bug fix: do not attempt to escape cookie values. + https://github.com/guzzle/guzzle/pull/1406 +* Feature: report original content encoding and length on decoded responses. + https://github.com/guzzle/guzzle/pull/1409 +* Bug fix: rewind seekable request bodies before dispatching to cURL. + https://github.com/guzzle/guzzle/pull/1422 +* Bug fix: provide an empty string to `http_build_query` for HHVM workaround. + https://github.com/guzzle/guzzle/pull/1367 + +## 6.1.1 - 2015-11-22 + +* Bug fix: Proxy::wrapSync() now correctly proxies to the appropriate handler + https://github.com/guzzle/guzzle/commit/911bcbc8b434adce64e223a6d1d14e9a8f63e4e4 +* Feature: HandlerStack is now more generic. + https://github.com/guzzle/guzzle/commit/f2102941331cda544745eedd97fc8fd46e1ee33e +* Bug fix: setting verify to false in the StreamHandler now disables peer + verification. https://github.com/guzzle/guzzle/issues/1256 +* Feature: Middleware now uses an exception factory, including more error + context. https://github.com/guzzle/guzzle/pull/1282 +* Feature: better support for disabled functions. + https://github.com/guzzle/guzzle/pull/1287 +* Bug fix: fixed regression where MockHandler was not using `sink`. + https://github.com/guzzle/guzzle/pull/1292 + +## 6.1.0 - 2015-09-08 + +* Feature: Added the `on_stats` request option to provide access to transfer + statistics for requests. https://github.com/guzzle/guzzle/pull/1202 +* Feature: Added the ability to persist session cookies in CookieJars. + https://github.com/guzzle/guzzle/pull/1195 +* Feature: Some compatibility updates for Google APP Engine + https://github.com/guzzle/guzzle/pull/1216 +* Feature: Added support for NO_PROXY to prevent the use of a proxy based on + a simple set of rules. https://github.com/guzzle/guzzle/pull/1197 +* Feature: Cookies can now contain square brackets. + https://github.com/guzzle/guzzle/pull/1237 +* Bug fix: Now correctly parsing `=` inside of quotes in Cookies. + https://github.com/guzzle/guzzle/pull/1232 +* Bug fix: Cusotm cURL options now correctly override curl options of the + same name. https://github.com/guzzle/guzzle/pull/1221 +* Bug fix: Content-Type header is now added when using an explicitly provided + multipart body. https://github.com/guzzle/guzzle/pull/1218 +* Bug fix: Now ignoring Set-Cookie headers that have no name. +* Bug fix: Reason phrase is no longer cast to an int in some cases in the + cURL handler. https://github.com/guzzle/guzzle/pull/1187 +* Bug fix: Remove the Authorization header when redirecting if the Host + header changes. https://github.com/guzzle/guzzle/pull/1207 +* Bug fix: Cookie path matching fixes + https://github.com/guzzle/guzzle/issues/1129 +* Bug fix: Fixing the cURL `body_as_string` setting + https://github.com/guzzle/guzzle/pull/1201 +* Bug fix: quotes are no longer stripped when parsing cookies. + https://github.com/guzzle/guzzle/issues/1172 +* Bug fix: `form_params` and `query` now always uses the `&` separator. + https://github.com/guzzle/guzzle/pull/1163 +* Bug fix: Adding a Content-Length to PHP stream wrapper requests if not set. + https://github.com/guzzle/guzzle/pull/1189 + +## 6.0.2 - 2015-07-04 + +* Fixed a memory leak in the curl handlers in which references to callbacks + were not being removed by `curl_reset`. +* Cookies are now extracted properly before redirects. +* Cookies now allow more character ranges. +* Decoded Content-Encoding responses are now modified to correctly reflect + their state if the encoding was automatically removed by a handler. This + means that the `Content-Encoding` header may be removed an the + `Content-Length` modified to reflect the message size after removing the + encoding. +* Added a more explicit error message when trying to use `form_params` and + `multipart` in the same request. +* Several fixes for HHVM support. +* Functions are now conditionally required using an additional level of + indirection to help with global Composer installations. + +## 6.0.1 - 2015-05-27 + +* Fixed a bug with serializing the `query` request option where the `&` + separator was missing. +* Added a better error message for when `body` is provided as an array. Please + use `form_params` or `multipart` instead. +* Various doc fixes. + +## 6.0.0 - 2015-05-26 + +* See the UPGRADING.md document for more information. +* Added `multipart` and `form_params` request options. +* Added `synchronous` request option. +* Added the `on_headers` request option. +* Fixed `expect` handling. +* No longer adding default middlewares in the client ctor. These need to be + present on the provided handler in order to work. +* Requests are no longer initiated when sending async requests with the + CurlMultiHandler. This prevents unexpected recursion from requests completing + while ticking the cURL loop. +* Removed the semantics of setting `default` to `true`. This is no longer + required now that the cURL loop is not ticked for async requests. +* Added request and response logging middleware. +* No longer allowing self signed certificates when using the StreamHandler. +* Ensuring that `sink` is valid if saving to a file. +* Request exceptions now include a "handler context" which provides handler + specific contextual information. +* Added `GuzzleHttp\RequestOptions` to allow request options to be applied + using constants. +* `$maxHandles` has been removed from CurlMultiHandler. +* `MultipartPostBody` is now part of the `guzzlehttp/psr7` package. + +## 5.3.0 - 2015-05-19 + +* Mock now supports `save_to` +* Marked `AbstractRequestEvent::getTransaction()` as public. +* Fixed a bug in which multiple headers using different casing would overwrite + previous headers in the associative array. +* Added `Utils::getDefaultHandler()` +* Marked `GuzzleHttp\Client::getDefaultUserAgent` as deprecated. +* URL scheme is now always lowercased. + +## 6.0.0-beta.1 + +* Requires PHP >= 5.5 +* Updated to use PSR-7 + * Requires immutable messages, which basically means an event based system + owned by a request instance is no longer possible. + * Utilizing the [Guzzle PSR-7 package](https://github.com/guzzle/psr7). + * Removed the dependency on `guzzlehttp/streams`. These stream abstractions + are available in the `guzzlehttp/psr7` package under the `GuzzleHttp\Psr7` + namespace. +* Added middleware and handler system + * Replaced the Guzzle event and subscriber system with a middleware system. + * No longer depends on RingPHP, but rather places the HTTP handlers directly + in Guzzle, operating on PSR-7 messages. + * Retry logic is now encapsulated in `GuzzleHttp\Middleware::retry`, which + means the `guzzlehttp/retry-subscriber` is now obsolete. + * Mocking responses is now handled using `GuzzleHttp\Handler\MockHandler`. +* Asynchronous responses + * No longer supports the `future` request option to send an async request. + Instead, use one of the `*Async` methods of a client (e.g., `requestAsync`, + `getAsync`, etc.). + * Utilizing `GuzzleHttp\Promise` instead of React's promise library to avoid + recursion required by chaining and forwarding react promises. See + https://github.com/guzzle/promises + * Added `requestAsync` and `sendAsync` to send request asynchronously. + * Added magic methods for `getAsync()`, `postAsync()`, etc. to send requests + asynchronously. +* Request options + * POST and form updates + * Added the `form_fields` and `form_files` request options. + * Removed the `GuzzleHttp\Post` namespace. + * The `body` request option no longer accepts an array for POST requests. + * The `exceptions` request option has been deprecated in favor of the + `http_errors` request options. + * The `save_to` request option has been deprecated in favor of `sink` request + option. +* Clients no longer accept an array of URI template string and variables for + URI variables. You will need to expand URI templates before passing them + into a client constructor or request method. +* Client methods `get()`, `post()`, `put()`, `patch()`, `options()`, etc. are + now magic methods that will send synchronous requests. +* Replaced `Utils.php` with plain functions in `functions.php`. +* Removed `GuzzleHttp\Collection`. +* Removed `GuzzleHttp\BatchResults`. Batched pool results are now returned as + an array. +* Removed `GuzzleHttp\Query`. Query string handling is now handled using an + associative array passed into the `query` request option. The query string + is serialized using PHP's `http_build_query`. If you need more control, you + can pass the query string in as a string. +* `GuzzleHttp\QueryParser` has been replaced with the + `GuzzleHttp\Psr7\parse_query`. + +## 5.2.0 - 2015-01-27 + +* Added `AppliesHeadersInterface` to make applying headers to a request based + on the body more generic and not specific to `PostBodyInterface`. +* Reduced the number of stack frames needed to send requests. +* Nested futures are now resolved in the client rather than the RequestFsm +* Finishing state transitions is now handled in the RequestFsm rather than the + RingBridge. +* Added a guard in the Pool class to not use recursion for request retries. + +## 5.1.0 - 2014-12-19 + +* Pool class no longer uses recursion when a request is intercepted. +* The size of a Pool can now be dynamically adjusted using a callback. + See https://github.com/guzzle/guzzle/pull/943. +* Setting a request option to `null` when creating a request with a client will + ensure that the option is not set. This allows you to overwrite default + request options on a per-request basis. + See https://github.com/guzzle/guzzle/pull/937. +* Added the ability to limit which protocols are allowed for redirects by + specifying a `protocols` array in the `allow_redirects` request option. +* Nested futures due to retries are now resolved when waiting for synchronous + responses. See https://github.com/guzzle/guzzle/pull/947. +* `"0"` is now an allowed URI path. See + https://github.com/guzzle/guzzle/pull/935. +* `Query` no longer typehints on the `$query` argument in the constructor, + allowing for strings and arrays. +* Exceptions thrown in the `end` event are now correctly wrapped with Guzzle + specific exceptions if necessary. + +## 5.0.3 - 2014-11-03 + +This change updates query strings so that they are treated as un-encoded values +by default where the value represents an un-encoded value to send over the +wire. A Query object then encodes the value before sending over the wire. This +means that even value query string values (e.g., ":") are url encoded. This +makes the Query class match PHP's http_build_query function. However, if you +want to send requests over the wire using valid query string characters that do +not need to be encoded, then you can provide a string to Url::setQuery() and +pass true as the second argument to specify that the query string is a raw +string that should not be parsed or encoded (unless a call to getQuery() is +subsequently made, forcing the query-string to be converted into a Query +object). + +## 5.0.2 - 2014-10-30 + +* Added a trailing `\r\n` to multipart/form-data payloads. See + https://github.com/guzzle/guzzle/pull/871 +* Added a `GuzzleHttp\Pool::send()` convenience method to match the docs. +* Status codes are now returned as integers. See + https://github.com/guzzle/guzzle/issues/881 +* No longer overwriting an existing `application/x-www-form-urlencoded` header + when sending POST requests, allowing for customized headers. See + https://github.com/guzzle/guzzle/issues/877 +* Improved path URL serialization. + + * No longer double percent-encoding characters in the path or query string if + they are already encoded. + * Now properly encoding the supplied path to a URL object, instead of only + encoding ' ' and '?'. + * Note: This has been changed in 5.0.3 to now encode query string values by + default unless the `rawString` argument is provided when setting the query + string on a URL: Now allowing many more characters to be present in the + query string without being percent encoded. See https://tools.ietf.org/html/rfc3986#appendix-A + +## 5.0.1 - 2014-10-16 + +Bugfix release. + +* Fixed an issue where connection errors still returned response object in + error and end events event though the response is unusable. This has been + corrected so that a response is not returned in the `getResponse` method of + these events if the response did not complete. https://github.com/guzzle/guzzle/issues/867 +* Fixed an issue where transfer statistics were not being populated in the + RingBridge. https://github.com/guzzle/guzzle/issues/866 + +## 5.0.0 - 2014-10-12 + +Adding support for non-blocking responses and some minor API cleanup. + +### New Features + +* Added support for non-blocking responses based on `guzzlehttp/guzzle-ring`. +* Added a public API for creating a default HTTP adapter. +* Updated the redirect plugin to be non-blocking so that redirects are sent + concurrently. Other plugins like this can now be updated to be non-blocking. +* Added a "progress" event so that you can get upload and download progress + events. +* Added `GuzzleHttp\Pool` which implements FutureInterface and transfers + requests concurrently using a capped pool size as efficiently as possible. +* Added `hasListeners()` to EmitterInterface. +* Removed `GuzzleHttp\ClientInterface::sendAll` and marked + `GuzzleHttp\Client::sendAll` as deprecated (it's still there, just not the + recommended way). + +### Breaking changes + +The breaking changes in this release are relatively minor. The biggest thing to +look out for is that request and response objects no longer implement fluent +interfaces. + +* Removed the fluent interfaces (i.e., `return $this`) from requests, + responses, `GuzzleHttp\Collection`, `GuzzleHttp\Url`, + `GuzzleHttp\Query`, `GuzzleHttp\Post\PostBody`, and + `GuzzleHttp\Cookie\SetCookie`. This blog post provides a good outline of + why I did this: https://ocramius.github.io/blog/fluent-interfaces-are-evil/. + This also makes the Guzzle message interfaces compatible with the current + PSR-7 message proposal. +* Removed "functions.php", so that Guzzle is truly PSR-4 compliant. Except + for the HTTP request functions from function.php, these functions are now + implemented in `GuzzleHttp\Utils` using camelCase. `GuzzleHttp\json_decode` + moved to `GuzzleHttp\Utils::jsonDecode`. `GuzzleHttp\get_path` moved to + `GuzzleHttp\Utils::getPath`. `GuzzleHttp\set_path` moved to + `GuzzleHttp\Utils::setPath`. `GuzzleHttp\batch` should now be + `GuzzleHttp\Pool::batch`, which returns an `objectStorage`. Using functions.php + caused problems for many users: they aren't PSR-4 compliant, require an + explicit include, and needed an if-guard to ensure that the functions are not + declared multiple times. +* Rewrote adapter layer. + * Removing all classes from `GuzzleHttp\Adapter`, these are now + implemented as callables that are stored in `GuzzleHttp\Ring\Client`. + * Removed the concept of "parallel adapters". Sending requests serially or + concurrently is now handled using a single adapter. + * Moved `GuzzleHttp\Adapter\Transaction` to `GuzzleHttp\Transaction`. The + Transaction object now exposes the request, response, and client as public + properties. The getters and setters have been removed. +* Removed the "headers" event. This event was only useful for changing the + body a response once the headers of the response were known. You can implement + a similar behavior in a number of ways. One example might be to use a + FnStream that has access to the transaction being sent. For example, when the + first byte is written, you could check if the response headers match your + expectations, and if so, change the actual stream body that is being + written to. +* Removed the `asArray` parameter from + `GuzzleHttp\Message\MessageInterface::getHeader`. If you want to get a header + value as an array, then use the newly added `getHeaderAsArray()` method of + `MessageInterface`. This change makes the Guzzle interfaces compatible with + the PSR-7 interfaces. +* `GuzzleHttp\Message\MessageFactory` no longer allows subclasses to add + custom request options using double-dispatch (this was an implementation + detail). Instead, you should now provide an associative array to the + constructor which is a mapping of the request option name mapping to a + function that applies the option value to a request. +* Removed the concept of "throwImmediately" from exceptions and error events. + This control mechanism was used to stop a transfer of concurrent requests + from completing. This can now be handled by throwing the exception or by + cancelling a pool of requests or each outstanding future request individually. +* Updated to "GuzzleHttp\Streams" 3.0. + * `GuzzleHttp\Stream\StreamInterface::getContents()` no longer accepts a + `maxLen` parameter. This update makes the Guzzle streams project + compatible with the current PSR-7 proposal. + * `GuzzleHttp\Stream\Stream::__construct`, + `GuzzleHttp\Stream\Stream::factory`, and + `GuzzleHttp\Stream\Utils::create` no longer accept a size in the second + argument. They now accept an associative array of options, including the + "size" key and "metadata" key which can be used to provide custom metadata. + +## 4.2.2 - 2014-09-08 + +* Fixed a memory leak in the CurlAdapter when reusing cURL handles. +* No longer using `request_fulluri` in stream adapter proxies. +* Relative redirects are now based on the last response, not the first response. + +## 4.2.1 - 2014-08-19 + +* Ensuring that the StreamAdapter does not always add a Content-Type header +* Adding automated github releases with a phar and zip + +## 4.2.0 - 2014-08-17 + +* Now merging in default options using a case-insensitive comparison. + Closes https://github.com/guzzle/guzzle/issues/767 +* Added the ability to automatically decode `Content-Encoding` response bodies + using the `decode_content` request option. This is set to `true` by default + to decode the response body if it comes over the wire with a + `Content-Encoding`. Set this value to `false` to disable decoding the + response content, and pass a string to provide a request `Accept-Encoding` + header and turn on automatic response decoding. This feature now allows you + to pass an `Accept-Encoding` header in the headers of a request but still + disable automatic response decoding. + Closes https://github.com/guzzle/guzzle/issues/764 +* Added the ability to throw an exception immediately when transferring + requests in parallel. Closes https://github.com/guzzle/guzzle/issues/760 +* Updating guzzlehttp/streams dependency to ~2.1 +* No longer utilizing the now deprecated namespaced methods from the stream + package. + +## 4.1.8 - 2014-08-14 + +* Fixed an issue in the CurlFactory that caused setting the `stream=false` + request option to throw an exception. + See: https://github.com/guzzle/guzzle/issues/769 +* TransactionIterator now calls rewind on the inner iterator. + See: https://github.com/guzzle/guzzle/pull/765 +* You can now set the `Content-Type` header to `multipart/form-data` + when creating POST requests to force multipart bodies. + See https://github.com/guzzle/guzzle/issues/768 + +## 4.1.7 - 2014-08-07 + +* Fixed an error in the HistoryPlugin that caused the same request and response + to be logged multiple times when an HTTP protocol error occurs. +* Ensuring that cURL does not add a default Content-Type when no Content-Type + has been supplied by the user. This prevents the adapter layer from modifying + the request that is sent over the wire after any listeners may have already + put the request in a desired state (e.g., signed the request). +* Throwing an exception when you attempt to send requests that have the + "stream" set to true in parallel using the MultiAdapter. +* Only calling curl_multi_select when there are active cURL handles. This was + previously changed and caused performance problems on some systems due to PHP + always selecting until the maximum select timeout. +* Fixed a bug where multipart/form-data POST fields were not correctly + aggregated (e.g., values with "&"). + +## 4.1.6 - 2014-08-03 + +* Added helper methods to make it easier to represent messages as strings, + including getting the start line and getting headers as a string. + +## 4.1.5 - 2014-08-02 + +* Automatically retrying cURL "Connection died, retrying a fresh connect" + errors when possible. +* cURL implementation cleanup +* Allowing multiple event subscriber listeners to be registered per event by + passing an array of arrays of listener configuration. + +## 4.1.4 - 2014-07-22 + +* Fixed a bug that caused multi-part POST requests with more than one field to + serialize incorrectly. +* Paths can now be set to "0" +* `ResponseInterface::xml` now accepts a `libxml_options` option and added a + missing default argument that was required when parsing XML response bodies. +* A `save_to` stream is now created lazily, which means that files are not + created on disk unless a request succeeds. + +## 4.1.3 - 2014-07-15 + +* Various fixes to multipart/form-data POST uploads +* Wrapping function.php in an if-statement to ensure Guzzle can be used + globally and in a Composer install +* Fixed an issue with generating and merging in events to an event array +* POST headers are only applied before sending a request to allow you to change + the query aggregator used before uploading +* Added much more robust query string parsing +* Fixed various parsing and normalization issues with URLs +* Fixing an issue where multi-valued headers were not being utilized correctly + in the StreamAdapter + +## 4.1.2 - 2014-06-18 + +* Added support for sending payloads with GET requests + +## 4.1.1 - 2014-06-08 + +* Fixed an issue related to using custom message factory options in subclasses +* Fixed an issue with nested form fields in a multi-part POST +* Fixed an issue with using the `json` request option for POST requests +* Added `ToArrayInterface` to `GuzzleHttp\Cookie\CookieJar` + +## 4.1.0 - 2014-05-27 + +* Added a `json` request option to easily serialize JSON payloads. +* Added a `GuzzleHttp\json_decode()` wrapper to safely parse JSON. +* Added `setPort()` and `getPort()` to `GuzzleHttp\Message\RequestInterface`. +* Added the ability to provide an emitter to a client in the client constructor. +* Added the ability to persist a cookie session using $_SESSION. +* Added a trait that can be used to add event listeners to an iterator. +* Removed request method constants from RequestInterface. +* Fixed warning when invalid request start-lines are received. +* Updated MessageFactory to work with custom request option methods. +* Updated cacert bundle to latest build. + +4.0.2 (2014-04-16) +------------------ + +* Proxy requests using the StreamAdapter now properly use request_fulluri (#632) +* Added the ability to set scalars as POST fields (#628) + +## 4.0.1 - 2014-04-04 + +* The HTTP status code of a response is now set as the exception code of + RequestException objects. +* 303 redirects will now correctly switch from POST to GET requests. +* The default parallel adapter of a client now correctly uses the MultiAdapter. +* HasDataTrait now initializes the internal data array as an empty array so + that the toArray() method always returns an array. + +## 4.0.0 - 2014-03-29 + +* For information on changes and upgrading, see: + https://github.com/guzzle/guzzle/blob/master/UPGRADING.md#3x-to-40 +* Added `GuzzleHttp\batch()` as a convenience function for sending requests in + parallel without needing to write asynchronous code. +* Restructured how events are added to `GuzzleHttp\ClientInterface::sendAll()`. + You can now pass a callable or an array of associative arrays where each + associative array contains the "fn", "priority", and "once" keys. + +## 4.0.0.rc-2 - 2014-03-25 + +* Removed `getConfig()` and `setConfig()` from clients to avoid confusion + around whether things like base_url, message_factory, etc. should be able to + be retrieved or modified. +* Added `getDefaultOption()` and `setDefaultOption()` to ClientInterface +* functions.php functions were renamed using snake_case to match PHP idioms +* Added support for `HTTP_PROXY`, `HTTPS_PROXY`, and + `GUZZLE_CURL_SELECT_TIMEOUT` environment variables +* Added the ability to specify custom `sendAll()` event priorities +* Added the ability to specify custom stream context options to the stream + adapter. +* Added a functions.php function for `get_path()` and `set_path()` +* CurlAdapter and MultiAdapter now use a callable to generate curl resources +* MockAdapter now properly reads a body and emits a `headers` event +* Updated Url class to check if a scheme and host are set before adding ":" + and "//". This allows empty Url (e.g., "") to be serialized as "". +* Parsing invalid XML no longer emits warnings +* Curl classes now properly throw AdapterExceptions +* Various performance optimizations +* Streams are created with the faster `Stream\create()` function +* Marked deprecation_proxy() as internal +* Test server is now a collection of static methods on a class + +## 4.0.0-rc.1 - 2014-03-15 + +* See https://github.com/guzzle/guzzle/blob/master/UPGRADING.md#3x-to-40 + +## 3.8.1 - 2014-01-28 + +* Bug: Always using GET requests when redirecting from a 303 response +* Bug: CURLOPT_SSL_VERIFYHOST is now correctly set to false when setting `$certificateAuthority` to false in + `Guzzle\Http\ClientInterface::setSslVerification()` +* Bug: RedirectPlugin now uses strict RFC 3986 compliance when combining a base URL with a relative URL +* Bug: The body of a request can now be set to `"0"` +* Sending PHP stream requests no longer forces `HTTP/1.0` +* Adding more information to ExceptionCollection exceptions so that users have more context, including a stack trace of + each sub-exception +* Updated the `$ref` attribute in service descriptions to merge over any existing parameters of a schema (rather than + clobbering everything). +* Merging URLs will now use the query string object from the relative URL (thus allowing custom query aggregators) +* Query strings are now parsed in a way that they do no convert empty keys with no value to have a dangling `=`. + For example `foo&bar=baz` is now correctly parsed and recognized as `foo&bar=baz` rather than `foo=&bar=baz`. +* Now properly escaping the regular expression delimiter when matching Cookie domains. +* Network access is now disabled when loading XML documents + +## 3.8.0 - 2013-12-05 + +* Added the ability to define a POST name for a file +* JSON response parsing now properly walks additionalProperties +* cURL error code 18 is now retried automatically in the BackoffPlugin +* Fixed a cURL error when URLs contain fragments +* Fixed an issue in the BackoffPlugin retry event where it was trying to access all exceptions as if they were + CurlExceptions +* CURLOPT_PROGRESS function fix for PHP 5.5 (69fcc1e) +* Added the ability for Guzzle to work with older versions of cURL that do not support `CURLOPT_TIMEOUT_MS` +* Fixed a bug that was encountered when parsing empty header parameters +* UriTemplate now has a `setRegex()` method to match the docs +* The `debug` request parameter now checks if it is truthy rather than if it exists +* Setting the `debug` request parameter to true shows verbose cURL output instead of using the LogPlugin +* Added the ability to combine URLs using strict RFC 3986 compliance +* Command objects can now return the validation errors encountered by the command +* Various fixes to cache revalidation (#437 and 29797e5) +* Various fixes to the AsyncPlugin +* Cleaned up build scripts + +## 3.7.4 - 2013-10-02 + +* Bug fix: 0 is now an allowed value in a description parameter that has a default value (#430) +* Bug fix: SchemaFormatter now returns an integer when formatting to a Unix timestamp + (see https://github.com/aws/aws-sdk-php/issues/147) +* Bug fix: Cleaned up and fixed URL dot segment removal to properly resolve internal dots +* Minimum PHP version is now properly specified as 5.3.3 (up from 5.3.2) (#420) +* Updated the bundled cacert.pem (#419) +* OauthPlugin now supports adding authentication to headers or query string (#425) + +## 3.7.3 - 2013-09-08 + +* Added the ability to get the exception associated with a request/command when using `MultiTransferException` and + `CommandTransferException`. +* Setting `additionalParameters` of a response to false is now honored when parsing responses with a service description +* Schemas are only injected into response models when explicitly configured. +* No longer guessing Content-Type based on the path of a request. Content-Type is now only guessed based on the path of + an EntityBody. +* Bug fix: ChunkedIterator can now properly chunk a \Traversable as well as an \Iterator. +* Bug fix: FilterIterator now relies on `\Iterator` instead of `\Traversable`. +* Bug fix: Gracefully handling malformed responses in RequestMediator::writeResponseBody() +* Bug fix: Replaced call to canCache with canCacheRequest in the CallbackCanCacheStrategy of the CachePlugin +* Bug fix: Visiting XML attributes first before visiting XML children when serializing requests +* Bug fix: Properly parsing headers that contain commas contained in quotes +* Bug fix: mimetype guessing based on a filename is now case-insensitive + +## 3.7.2 - 2013-08-02 + +* Bug fix: Properly URL encoding paths when using the PHP-only version of the UriTemplate expander + See https://github.com/guzzle/guzzle/issues/371 +* Bug fix: Cookie domains are now matched correctly according to RFC 6265 + See https://github.com/guzzle/guzzle/issues/377 +* Bug fix: GET parameters are now used when calculating an OAuth signature +* Bug fix: Fixed an issue with cache revalidation where the If-None-Match header was being double quoted +* `Guzzle\Common\AbstractHasDispatcher::dispatch()` now returns the event that was dispatched +* `Guzzle\Http\QueryString::factory()` now guesses the most appropriate query aggregator to used based on the input. + See https://github.com/guzzle/guzzle/issues/379 +* Added a way to add custom domain objects to service description parsing using the `operation.parse_class` event. See + https://github.com/guzzle/guzzle/pull/380 +* cURL multi cleanup and optimizations + +## 3.7.1 - 2013-07-05 + +* Bug fix: Setting default options on a client now works +* Bug fix: Setting options on HEAD requests now works. See #352 +* Bug fix: Moving stream factory before send event to before building the stream. See #353 +* Bug fix: Cookies no longer match on IP addresses per RFC 6265 +* Bug fix: Correctly parsing header parameters that are in `<>` and quotes +* Added `cert` and `ssl_key` as request options +* `Host` header can now diverge from the host part of a URL if the header is set manually +* `Guzzle\Service\Command\LocationVisitor\Request\XmlVisitor` was rewritten to change from using SimpleXML to XMLWriter +* OAuth parameters are only added via the plugin if they aren't already set +* Exceptions are now thrown when a URL cannot be parsed +* Returning `false` if `Guzzle\Http\EntityBody::getContentMd5()` fails +* Not setting a `Content-MD5` on a command if calculating the Content-MD5 fails via the CommandContentMd5Plugin + +## 3.7.0 - 2013-06-10 + +* See UPGRADING.md for more information on how to upgrade. +* Requests now support the ability to specify an array of $options when creating a request to more easily modify a + request. You can pass a 'request.options' configuration setting to a client to apply default request options to + every request created by a client (e.g. default query string variables, headers, curl options, etc.). +* Added a static facade class that allows you to use Guzzle with static methods and mount the class to `\Guzzle`. + See `Guzzle\Http\StaticClient::mount`. +* Added `command.request_options` to `Guzzle\Service\Command\AbstractCommand` to pass request options to requests + created by a command (e.g. custom headers, query string variables, timeout settings, etc.). +* Stream size in `Guzzle\Stream\PhpStreamRequestFactory` will now be set if Content-Length is returned in the + headers of a response +* Added `Guzzle\Common\Collection::setPath($path, $value)` to set a value into an array using a nested key + (e.g. `$collection->setPath('foo/baz/bar', 'test'); echo $collection['foo']['bar']['bar'];`) +* ServiceBuilders now support storing and retrieving arbitrary data +* CachePlugin can now purge all resources for a given URI +* CachePlugin can automatically purge matching cached items when a non-idempotent request is sent to a resource +* CachePlugin now uses the Vary header to determine if a resource is a cache hit +* `Guzzle\Http\Message\Response` now implements `\Serializable` +* Added `Guzzle\Cache\CacheAdapterFactory::fromCache()` to more easily create cache adapters +* `Guzzle\Service\ClientInterface::execute()` now accepts an array, single command, or Traversable +* Fixed a bug in `Guzzle\Http\Message\Header\Link::addLink()` +* Better handling of calculating the size of a stream in `Guzzle\Stream\Stream` using fstat() and caching the size +* `Guzzle\Common\Exception\ExceptionCollection` now creates a more readable exception message +* Fixing BC break: Added back the MonologLogAdapter implementation rather than extending from PsrLog so that older + Symfony users can still use the old version of Monolog. +* Fixing BC break: Added the implementation back in for `Guzzle\Http\Message\AbstractMessage::getTokenizedHeader()`. + Now triggering an E_USER_DEPRECATED warning when used. Use `$message->getHeader()->parseParams()`. +* Several performance improvements to `Guzzle\Common\Collection` +* Added an `$options` argument to the end of the following methods of `Guzzle\Http\ClientInterface`: + createRequest, head, delete, put, patch, post, options, prepareRequest +* Added an `$options` argument to the end of `Guzzle\Http\Message\Request\RequestFactoryInterface::createRequest()` +* Added an `applyOptions()` method to `Guzzle\Http\Message\Request\RequestFactoryInterface` +* Changed `Guzzle\Http\ClientInterface::get($uri = null, $headers = null, $body = null)` to + `Guzzle\Http\ClientInterface::get($uri = null, $headers = null, $options = array())`. You can still pass in a + resource, string, or EntityBody into the $options parameter to specify the download location of the response. +* Changed `Guzzle\Common\Collection::__construct($data)` to no longer accepts a null value for `$data` but a + default `array()` +* Added `Guzzle\Stream\StreamInterface::isRepeatable` +* Removed `Guzzle\Http\ClientInterface::setDefaultHeaders(). Use + $client->getConfig()->setPath('request.options/headers/{header_name}', 'value')`. or + $client->getConfig()->setPath('request.options/headers', array('header_name' => 'value'))`. +* Removed `Guzzle\Http\ClientInterface::getDefaultHeaders(). Use $client->getConfig()->getPath('request.options/headers')`. +* Removed `Guzzle\Http\ClientInterface::expandTemplate()` +* Removed `Guzzle\Http\ClientInterface::setRequestFactory()` +* Removed `Guzzle\Http\ClientInterface::getCurlMulti()` +* Removed `Guzzle\Http\Message\RequestInterface::canCache` +* Removed `Guzzle\Http\Message\RequestInterface::setIsRedirect` +* Removed `Guzzle\Http\Message\RequestInterface::isRedirect` +* Made `Guzzle\Http\Client::expandTemplate` and `getUriTemplate` protected methods. +* You can now enable E_USER_DEPRECATED warnings to see if you are using a deprecated method by setting + `Guzzle\Common\Version::$emitWarnings` to true. +* Marked `Guzzle\Http\Message\Request::isResponseBodyRepeatable()` as deprecated. Use + `$request->getResponseBody()->isRepeatable()` instead. +* Marked `Guzzle\Http\Message\Request::canCache()` as deprecated. Use + `Guzzle\Plugin\Cache\DefaultCanCacheStrategy->canCacheRequest()` instead. +* Marked `Guzzle\Http\Message\Request::canCache()` as deprecated. Use + `Guzzle\Plugin\Cache\DefaultCanCacheStrategy->canCacheRequest()` instead. +* Marked `Guzzle\Http\Message\Request::setIsRedirect()` as deprecated. Use the HistoryPlugin instead. +* Marked `Guzzle\Http\Message\Request::isRedirect()` as deprecated. Use the HistoryPlugin instead. +* Marked `Guzzle\Cache\CacheAdapterFactory::factory()` as deprecated +* Marked 'command.headers', 'command.response_body' and 'command.on_complete' as deprecated for AbstractCommand. + These will work through Guzzle 4.0 +* Marked 'request.params' for `Guzzle\Http\Client` as deprecated. Use [request.options][params]. +* Marked `Guzzle\Service\Client::enableMagicMethods()` as deprecated. Magic methods can no longer be disabled on a Guzzle\Service\Client. +* Marked `Guzzle\Service\Client::getDefaultHeaders()` as deprecated. Use $client->getConfig()->getPath('request.options/headers')`. +* Marked `Guzzle\Service\Client::setDefaultHeaders()` as deprecated. Use $client->getConfig()->setPath('request.options/headers/{header_name}', 'value')`. +* Marked `Guzzle\Parser\Url\UrlParser` as deprecated. Just use PHP's `parse_url()` and percent encode your UTF-8. +* Marked `Guzzle\Common\Collection::inject()` as deprecated. +* Marked `Guzzle\Plugin\CurlAuth\CurlAuthPlugin` as deprecated. Use `$client->getConfig()->setPath('request.options/auth', array('user', 'pass', 'Basic|Digest');` +* CacheKeyProviderInterface and DefaultCacheKeyProvider are no longer used. All of this logic is handled in a + CacheStorageInterface. These two objects and interface will be removed in a future version. +* Always setting X-cache headers on cached responses +* Default cache TTLs are now handled by the CacheStorageInterface of a CachePlugin +* `CacheStorageInterface::cache($key, Response $response, $ttl = null)` has changed to `cache(RequestInterface + $request, Response $response);` +* `CacheStorageInterface::fetch($key)` has changed to `fetch(RequestInterface $request);` +* `CacheStorageInterface::delete($key)` has changed to `delete(RequestInterface $request);` +* Added `CacheStorageInterface::purge($url)` +* `DefaultRevalidation::__construct(CacheKeyProviderInterface $cacheKey, CacheStorageInterface $cache, CachePlugin + $plugin)` has changed to `DefaultRevalidation::__construct(CacheStorageInterface $cache, + CanCacheStrategyInterface $canCache = null)` +* Added `RevalidationInterface::shouldRevalidate(RequestInterface $request, Response $response)` + +## 3.6.0 - 2013-05-29 + +* ServiceDescription now implements ToArrayInterface +* Added command.hidden_params to blacklist certain headers from being treated as additionalParameters +* Guzzle can now correctly parse incomplete URLs +* Mixed casing of headers are now forced to be a single consistent casing across all values for that header. +* Messages internally use a HeaderCollection object to delegate handling case-insensitive header resolution +* Removed the whole changedHeader() function system of messages because all header changes now go through addHeader(). +* Specific header implementations can be created for complex headers. When a message creates a header, it uses a + HeaderFactory which can map specific headers to specific header classes. There is now a Link header and + CacheControl header implementation. +* Removed from interface: Guzzle\Http\ClientInterface::setUriTemplate +* Removed from interface: Guzzle\Http\ClientInterface::setCurlMulti() +* Removed Guzzle\Http\Message\Request::receivedRequestHeader() and implemented this functionality in + Guzzle\Http\Curl\RequestMediator +* Removed the optional $asString parameter from MessageInterface::getHeader(). Just cast the header to a string. +* Removed the optional $tryChunkedTransfer option from Guzzle\Http\Message\EntityEnclosingRequestInterface +* Removed the $asObjects argument from Guzzle\Http\Message\MessageInterface::getHeaders() +* Removed Guzzle\Parser\ParserRegister::get(). Use getParser() +* Removed Guzzle\Parser\ParserRegister::set(). Use registerParser(). +* All response header helper functions return a string rather than mixing Header objects and strings inconsistently +* Removed cURL blacklist support. This is no longer necessary now that Expect, Accept, etc. are managed by Guzzle + directly via interfaces +* Removed the injecting of a request object onto a response object. The methods to get and set a request still exist + but are a no-op until removed. +* Most classes that used to require a `Guzzle\Service\Command\CommandInterface` typehint now request a + `Guzzle\Service\Command\ArrayCommandInterface`. +* Added `Guzzle\Http\Message\RequestInterface::startResponse()` to the RequestInterface to handle injecting a response + on a request while the request is still being transferred +* The ability to case-insensitively search for header values +* Guzzle\Http\Message\Header::hasExactHeader +* Guzzle\Http\Message\Header::raw. Use getAll() +* Deprecated cache control specific methods on Guzzle\Http\Message\AbstractMessage. Use the CacheControl header object + instead. +* `Guzzle\Service\Command\CommandInterface` now extends from ToArrayInterface and ArrayAccess +* Added the ability to cast Model objects to a string to view debug information. + +## 3.5.0 - 2013-05-13 + +* Bug: Fixed a regression so that request responses are parsed only once per oncomplete event rather than multiple times +* Bug: Better cleanup of one-time events across the board (when an event is meant to fire once, it will now remove + itself from the EventDispatcher) +* Bug: `Guzzle\Log\MessageFormatter` now properly writes "total_time" and "connect_time" values +* Bug: Cloning an EntityEnclosingRequest now clones the EntityBody too +* Bug: Fixed an undefined index error when parsing nested JSON responses with a sentAs parameter that reference a + non-existent key +* Bug: All __call() method arguments are now required (helps with mocking frameworks) +* Deprecating Response::getRequest() and now using a shallow clone of a request object to remove a circular reference + to help with refcount based garbage collection of resources created by sending a request +* Deprecating ZF1 cache and log adapters. These will be removed in the next major version. +* Deprecating `Response::getPreviousResponse()` (method signature still exists, but it's deprecated). Use the + HistoryPlugin for a history. +* Added a `responseBody` alias for the `response_body` location +* Refactored internals to no longer rely on Response::getRequest() +* HistoryPlugin can now be cast to a string +* HistoryPlugin now logs transactions rather than requests and responses to more accurately keep track of the requests + and responses that are sent over the wire +* Added `getEffectiveUrl()` and `getRedirectCount()` to Response objects + +## 3.4.3 - 2013-04-30 + +* Bug fix: Fixing bug introduced in 3.4.2 where redirect responses are duplicated on the final redirected response +* Added a check to re-extract the temp cacert bundle from the phar before sending each request + +## 3.4.2 - 2013-04-29 + +* Bug fix: Stream objects now work correctly with "a" and "a+" modes +* Bug fix: Removing `Transfer-Encoding: chunked` header when a Content-Length is present +* Bug fix: AsyncPlugin no longer forces HEAD requests +* Bug fix: DateTime timezones are now properly handled when using the service description schema formatter +* Bug fix: CachePlugin now properly handles stale-if-error directives when a request to the origin server fails +* Setting a response on a request will write to the custom request body from the response body if one is specified +* LogPlugin now writes to php://output when STDERR is undefined +* Added the ability to set multiple POST files for the same key in a single call +* application/x-www-form-urlencoded POSTs now use the utf-8 charset by default +* Added the ability to queue CurlExceptions to the MockPlugin +* Cleaned up how manual responses are queued on requests (removed "queued_response" and now using request.before_send) +* Configuration loading now allows remote files + +## 3.4.1 - 2013-04-16 + +* Large refactoring to how CurlMulti handles work. There is now a proxy that sits in front of a pool of CurlMulti + handles. This greatly simplifies the implementation, fixes a couple bugs, and provides a small performance boost. +* Exceptions are now properly grouped when sending requests in parallel +* Redirects are now properly aggregated when a multi transaction fails +* Redirects now set the response on the original object even in the event of a failure +* Bug fix: Model names are now properly set even when using $refs +* Added support for PHP 5.5's CurlFile to prevent warnings with the deprecated @ syntax +* Added support for oauth_callback in OAuth signatures +* Added support for oauth_verifier in OAuth signatures +* Added support to attempt to retrieve a command first literally, then ucfirst, the with inflection + +## 3.4.0 - 2013-04-11 + +* Bug fix: URLs are now resolved correctly based on https://tools.ietf.org/html/rfc3986#section-5.2. #289 +* Bug fix: Absolute URLs with a path in a service description will now properly override the base URL. #289 +* Bug fix: Parsing a query string with a single PHP array value will now result in an array. #263 +* Bug fix: Better normalization of the User-Agent header to prevent duplicate headers. #264. +* Bug fix: Added `number` type to service descriptions. +* Bug fix: empty parameters are removed from an OAuth signature +* Bug fix: Revalidating a cache entry prefers the Last-Modified over the Date header +* Bug fix: Fixed "array to string" error when validating a union of types in a service description +* Bug fix: Removed code that attempted to determine the size of a stream when data is written to the stream +* Bug fix: Not including an `oauth_token` if the value is null in the OauthPlugin. +* Bug fix: Now correctly aggregating successful requests and failed requests in CurlMulti when a redirect occurs. +* The new default CURLOPT_TIMEOUT setting has been increased to 150 seconds so that Guzzle works on poor connections. +* Added a feature to EntityEnclosingRequest::setBody() that will automatically set the Content-Type of the request if + the Content-Type can be determined based on the entity body or the path of the request. +* Added the ability to overwrite configuration settings in a client when grabbing a throwaway client from a builder. +* Added support for a PSR-3 LogAdapter. +* Added a `command.after_prepare` event +* Added `oauth_callback` parameter to the OauthPlugin +* Added the ability to create a custom stream class when using a stream factory +* Added a CachingEntityBody decorator +* Added support for `additionalParameters` in service descriptions to define how custom parameters are serialized. +* The bundled SSL certificate is now provided in the phar file and extracted when running Guzzle from a phar. +* You can now send any EntityEnclosingRequest with POST fields or POST files and cURL will handle creating bodies +* POST requests using a custom entity body are now treated exactly like PUT requests but with a custom cURL method. This + means that the redirect behavior of POST requests with custom bodies will not be the same as POST requests that use + POST fields or files (the latter is only used when emulating a form POST in the browser). +* Lots of cleanup to CurlHandle::factory and RequestFactory::createRequest + +## 3.3.1 - 2013-03-10 + +* Added the ability to create PHP streaming responses from HTTP requests +* Bug fix: Running any filters when parsing response headers with service descriptions +* Bug fix: OauthPlugin fixes to allow for multi-dimensional array signing, and sorting parameters before signing +* Bug fix: Removed the adding of default empty arrays and false Booleans to responses in order to be consistent across + response location visitors. +* Bug fix: Removed the possibility of creating configuration files with circular dependencies +* RequestFactory::create() now uses the key of a POST file when setting the POST file name +* Added xmlAllowEmpty to serialize an XML body even if no XML specific parameters are set + +## 3.3.0 - 2013-03-03 + +* A large number of performance optimizations have been made +* Bug fix: Added 'wb' as a valid write mode for streams +* Bug fix: `Guzzle\Http\Message\Response::json()` now allows scalar values to be returned +* Bug fix: Fixed bug in `Guzzle\Http\Message\Response` where wrapping quotes were stripped from `getEtag()` +* BC: Removed `Guzzle\Http\Utils` class +* BC: Setting a service description on a client will no longer modify the client's command factories. +* BC: Emitting IO events from a RequestMediator is now a parameter that must be set in a request's curl options using + the 'emit_io' key. This was previously set under a request's parameters using 'curl.emit_io' +* BC: `Guzzle\Stream\Stream::getWrapper()` and `Guzzle\Stream\Stream::getSteamType()` are no longer converted to + lowercase +* Operation parameter objects are now lazy loaded internally +* Added ErrorResponsePlugin that can throw errors for responses defined in service description operations' errorResponses +* Added support for instantiating responseType=class responseClass classes. Classes must implement + `Guzzle\Service\Command\ResponseClassInterface` +* Added support for additionalProperties for top-level parameters in responseType=model responseClasses. These + additional properties also support locations and can be used to parse JSON responses where the outermost part of the + JSON is an array +* Added support for nested renaming of JSON models (rename sentAs to name) +* CachePlugin + * Added support for stale-if-error so that the CachePlugin can now serve stale content from the cache on error + * Debug headers can now added to cached response in the CachePlugin + +## 3.2.0 - 2013-02-14 + +* CurlMulti is no longer reused globally. A new multi object is created per-client. This helps to isolate clients. +* URLs with no path no longer contain a "/" by default +* Guzzle\Http\QueryString does no longer manages the leading "?". This is now handled in Guzzle\Http\Url. +* BadResponseException no longer includes the full request and response message +* Adding setData() to Guzzle\Service\Description\ServiceDescriptionInterface +* Adding getResponseBody() to Guzzle\Http\Message\RequestInterface +* Various updates to classes to use ServiceDescriptionInterface type hints rather than ServiceDescription +* Header values can now be normalized into distinct values when multiple headers are combined with a comma separated list +* xmlEncoding can now be customized for the XML declaration of a XML service description operation +* Guzzle\Http\QueryString now uses Guzzle\Http\QueryAggregator\QueryAggregatorInterface objects to add custom value + aggregation and no longer uses callbacks +* The URL encoding implementation of Guzzle\Http\QueryString can now be customized +* Bug fix: Filters were not always invoked for array service description parameters +* Bug fix: Redirects now use a target response body rather than a temporary response body +* Bug fix: The default exponential backoff BackoffPlugin was not giving when the request threshold was exceeded +* Bug fix: Guzzle now takes the first found value when grabbing Cache-Control directives + +## 3.1.2 - 2013-01-27 + +* Refactored how operation responses are parsed. Visitors now include a before() method responsible for parsing the + response body. For example, the XmlVisitor now parses the XML response into an array in the before() method. +* Fixed an issue where cURL would not automatically decompress responses when the Accept-Encoding header was sent +* CURLOPT_SSL_VERIFYHOST is never set to 1 because it is deprecated (see 5e0ff2ef20f839e19d1eeb298f90ba3598784444) +* Fixed a bug where redirect responses were not chained correctly using getPreviousResponse() +* Setting default headers on a client after setting the user-agent will not erase the user-agent setting + +## 3.1.1 - 2013-01-20 + +* Adding wildcard support to Guzzle\Common\Collection::getPath() +* Adding alias support to ServiceBuilder configs +* Adding Guzzle\Service\Resource\CompositeResourceIteratorFactory and cleaning up factory interface + +## 3.1.0 - 2013-01-12 + +* BC: CurlException now extends from RequestException rather than BadResponseException +* BC: Renamed Guzzle\Plugin\Cache\CanCacheStrategyInterface::canCache() to canCacheRequest() and added CanCacheResponse() +* Added getData to ServiceDescriptionInterface +* Added context array to RequestInterface::setState() +* Bug: Removing hard dependency on the BackoffPlugin from Guzzle\Http +* Bug: Adding required content-type when JSON request visitor adds JSON to a command +* Bug: Fixing the serialization of a service description with custom data +* Made it easier to deal with exceptions thrown when transferring commands or requests in parallel by providing + an array of successful and failed responses +* Moved getPath from Guzzle\Service\Resource\Model to Guzzle\Common\Collection +* Added Guzzle\Http\IoEmittingEntityBody +* Moved command filtration from validators to location visitors +* Added `extends` attributes to service description parameters +* Added getModels to ServiceDescriptionInterface + +## 3.0.7 - 2012-12-19 + +* Fixing phar detection when forcing a cacert to system if null or true +* Allowing filename to be passed to `Guzzle\Http\Message\Request::setResponseBody()` +* Cleaning up `Guzzle\Common\Collection::inject` method +* Adding a response_body location to service descriptions + +## 3.0.6 - 2012-12-09 + +* CurlMulti performance improvements +* Adding setErrorResponses() to Operation +* composer.json tweaks + +## 3.0.5 - 2012-11-18 + +* Bug: Fixing an infinite recursion bug caused from revalidating with the CachePlugin +* Bug: Response body can now be a string containing "0" +* Bug: Using Guzzle inside of a phar uses system by default but now allows for a custom cacert +* Bug: QueryString::fromString now properly parses query string parameters that contain equal signs +* Added support for XML attributes in service description responses +* DefaultRequestSerializer now supports array URI parameter values for URI template expansion +* Added better mimetype guessing to requests and post files + +## 3.0.4 - 2012-11-11 + +* Bug: Fixed a bug when adding multiple cookies to a request to use the correct glue value +* Bug: Cookies can now be added that have a name, domain, or value set to "0" +* Bug: Using the system cacert bundle when using the Phar +* Added json and xml methods to Response to make it easier to parse JSON and XML response data into data structures +* Enhanced cookie jar de-duplication +* Added the ability to enable strict cookie jars that throw exceptions when invalid cookies are added +* Added setStream to StreamInterface to actually make it possible to implement custom rewind behavior for entity bodies +* Added the ability to create any sort of hash for a stream rather than just an MD5 hash + +## 3.0.3 - 2012-11-04 + +* Implementing redirects in PHP rather than cURL +* Added PECL URI template extension and using as default parser if available +* Bug: Fixed Content-Length parsing of Response factory +* Adding rewind() method to entity bodies and streams. Allows for custom rewinding of non-repeatable streams. +* Adding ToArrayInterface throughout library +* Fixing OauthPlugin to create unique nonce values per request + +## 3.0.2 - 2012-10-25 + +* Magic methods are enabled by default on clients +* Magic methods return the result of a command +* Service clients no longer require a base_url option in the factory +* Bug: Fixed an issue with URI templates where null template variables were being expanded + +## 3.0.1 - 2012-10-22 + +* Models can now be used like regular collection objects by calling filter, map, etc. +* Models no longer require a Parameter structure or initial data in the constructor +* Added a custom AppendIterator to get around a PHP bug with the `\AppendIterator` + +## 3.0.0 - 2012-10-15 + +* Rewrote service description format to be based on Swagger + * Now based on JSON schema + * Added nested input structures and nested response models + * Support for JSON and XML input and output models + * Renamed `commands` to `operations` + * Removed dot class notation + * Removed custom types +* Broke the project into smaller top-level namespaces to be more component friendly +* Removed support for XML configs and descriptions. Use arrays or JSON files. +* Removed the Validation component and Inspector +* Moved all cookie code to Guzzle\Plugin\Cookie +* Magic methods on a Guzzle\Service\Client now return the command un-executed. +* Calling getResult() or getResponse() on a command will lazily execute the command if needed. +* Now shipping with cURL's CA certs and using it by default +* Added previousResponse() method to response objects +* No longer sending Accept and Accept-Encoding headers on every request +* Only sending an Expect header by default when a payload is greater than 1MB +* Added/moved client options: + * curl.blacklist to curl.option.blacklist + * Added ssl.certificate_authority +* Added a Guzzle\Iterator component +* Moved plugins from Guzzle\Http\Plugin to Guzzle\Plugin +* Added a more robust backoff retry strategy (replaced the ExponentialBackoffPlugin) +* Added a more robust caching plugin +* Added setBody to response objects +* Updating LogPlugin to use a more flexible MessageFormatter +* Added a completely revamped build process +* Cleaning up Collection class and removing default values from the get method +* Fixed ZF2 cache adapters + +## 2.8.8 - 2012-10-15 + +* Bug: Fixed a cookie issue that caused dot prefixed domains to not match where popular browsers did + +## 2.8.7 - 2012-09-30 + +* Bug: Fixed config file aliases for JSON includes +* Bug: Fixed cookie bug on a request object by using CookieParser to parse cookies on requests +* Bug: Removing the path to a file when sending a Content-Disposition header on a POST upload +* Bug: Hardening request and response parsing to account for missing parts +* Bug: Fixed PEAR packaging +* Bug: Fixed Request::getInfo +* Bug: Fixed cases where CURLM_CALL_MULTI_PERFORM return codes were causing curl transactions to fail +* Adding the ability for the namespace Iterator factory to look in multiple directories +* Added more getters/setters/removers from service descriptions +* Added the ability to remove POST fields from OAuth signatures +* OAuth plugin now supports 2-legged OAuth + +## 2.8.6 - 2012-09-05 + +* Added the ability to modify and build service descriptions +* Added the use of visitors to apply parameters to locations in service descriptions using the dynamic command +* Added a `json` parameter location +* Now allowing dot notation for classes in the CacheAdapterFactory +* Using the union of two arrays rather than an array_merge when extending service builder services and service params +* Ensuring that a service is a string before doing strpos() checks on it when substituting services for references + in service builder config files. +* Services defined in two different config files that include one another will by default replace the previously + defined service, but you can now create services that extend themselves and merge their settings over the previous +* The JsonLoader now supports aliasing filenames with different filenames. This allows you to alias something like + '_default' with a default JSON configuration file. + +## 2.8.5 - 2012-08-29 + +* Bug: Suppressed empty arrays from URI templates +* Bug: Added the missing $options argument from ServiceDescription::factory to enable caching +* Added support for HTTP responses that do not contain a reason phrase in the start-line +* AbstractCommand commands are now invokable +* Added a way to get the data used when signing an Oauth request before a request is sent + +## 2.8.4 - 2012-08-15 + +* Bug: Custom delay time calculations are no longer ignored in the ExponentialBackoffPlugin +* Added the ability to transfer entity bodies as a string rather than streamed. This gets around curl error 65. Set `body_as_string` in a request's curl options to enable. +* Added a StreamInterface, EntityBodyInterface, and added ftell() to Guzzle\Common\Stream +* Added an AbstractEntityBodyDecorator and a ReadLimitEntityBody decorator to transfer only a subset of a decorated stream +* Stream and EntityBody objects will now return the file position to the previous position after a read required operation (e.g. getContentMd5()) +* Added additional response status codes +* Removed SSL information from the default User-Agent header +* DELETE requests can now send an entity body +* Added an EventDispatcher to the ExponentialBackoffPlugin and added an ExponentialBackoffLogger to log backoff retries +* Added the ability of the MockPlugin to consume mocked request bodies +* LogPlugin now exposes request and response objects in the extras array + +## 2.8.3 - 2012-07-30 + +* Bug: Fixed a case where empty POST requests were sent as GET requests +* Bug: Fixed a bug in ExponentialBackoffPlugin that caused fatal errors when retrying an EntityEnclosingRequest that does not have a body +* Bug: Setting the response body of a request to null after completing a request, not when setting the state of a request to new +* Added multiple inheritance to service description commands +* Added an ApiCommandInterface and added `getParamNames()` and `hasParam()` +* Removed the default 2mb size cutoff from the Md5ValidatorPlugin so that it now defaults to validating everything +* Changed CurlMulti::perform to pass a smaller timeout to CurlMulti::executeHandles + +## 2.8.2 - 2012-07-24 + +* Bug: Query string values set to 0 are no longer dropped from the query string +* Bug: A Collection object is no longer created each time a call is made to `Guzzle\Service\Command\AbstractCommand::getRequestHeaders()` +* Bug: `+` is now treated as an encoded space when parsing query strings +* QueryString and Collection performance improvements +* Allowing dot notation for class paths in filters attribute of a service descriptions + +## 2.8.1 - 2012-07-16 + +* Loosening Event Dispatcher dependency +* POST redirects can now be customized using CURLOPT_POSTREDIR + +## 2.8.0 - 2012-07-15 + +* BC: Guzzle\Http\Query + * Query strings with empty variables will always show an equal sign unless the variable is set to QueryString::BLANK (e.g. ?acl= vs ?acl) + * Changed isEncodingValues() and isEncodingFields() to isUrlEncoding() + * Changed setEncodeValues(bool) and setEncodeFields(bool) to useUrlEncoding(bool) + * Changed the aggregation functions of QueryString to be static methods + * Can now use fromString() with querystrings that have a leading ? +* cURL configuration values can be specified in service descriptions using `curl.` prefixed parameters +* Content-Length is set to 0 before emitting the request.before_send event when sending an empty request body +* Cookies are no longer URL decoded by default +* Bug: URI template variables set to null are no longer expanded + +## 2.7.2 - 2012-07-02 + +* BC: Moving things to get ready for subtree splits. Moving Inflection into Common. Moving Guzzle\Http\Parser to Guzzle\Parser. +* BC: Removing Guzzle\Common\Batch\Batch::count() and replacing it with isEmpty() +* CachePlugin now allows for a custom request parameter function to check if a request can be cached +* Bug fix: CachePlugin now only caches GET and HEAD requests by default +* Bug fix: Using header glue when transferring headers over the wire +* Allowing deeply nested arrays for composite variables in URI templates +* Batch divisors can now return iterators or arrays + +## 2.7.1 - 2012-06-26 + +* Minor patch to update version number in UA string +* Updating build process + +## 2.7.0 - 2012-06-25 + +* BC: Inflection classes moved to Guzzle\Inflection. No longer static methods. Can now inject custom inflectors into classes. +* BC: Removed magic setX methods from commands +* BC: Magic methods mapped to service description commands are now inflected in the command factory rather than the client __call() method +* Verbose cURL options are no longer enabled by default. Set curl.debug to true on a client to enable. +* Bug: Now allowing colons in a response start-line (e.g. HTTP/1.1 503 Service Unavailable: Back-end server is at capacity) +* Guzzle\Service\Resource\ResourceIteratorApplyBatched now internally uses the Guzzle\Common\Batch namespace +* Added Guzzle\Service\Plugin namespace and a PluginCollectionPlugin +* Added the ability to set POST fields and files in a service description +* Guzzle\Http\EntityBody::factory() now accepts objects with a __toString() method +* Adding a command.before_prepare event to clients +* Added BatchClosureTransfer and BatchClosureDivisor +* BatchTransferException now includes references to the batch divisor and transfer strategies +* Fixed some tests so that they pass more reliably +* Added Guzzle\Common\Log\ArrayLogAdapter + +## 2.6.6 - 2012-06-10 + +* BC: Removing Guzzle\Http\Plugin\BatchQueuePlugin +* BC: Removing Guzzle\Service\Command\CommandSet +* Adding generic batching system (replaces the batch queue plugin and command set) +* Updating ZF cache and log adapters and now using ZF's composer repository +* Bug: Setting the name of each ApiParam when creating through an ApiCommand +* Adding result_type, result_doc, deprecated, and doc_url to service descriptions +* Bug: Changed the default cookie header casing back to 'Cookie' + +## 2.6.5 - 2012-06-03 + +* BC: Renaming Guzzle\Http\Message\RequestInterface::getResourceUri() to getResource() +* BC: Removing unused AUTH_BASIC and AUTH_DIGEST constants from +* BC: Guzzle\Http\Cookie is now used to manage Set-Cookie data, not Cookie data +* BC: Renaming methods in the CookieJarInterface +* Moving almost all cookie logic out of the CookiePlugin and into the Cookie or CookieJar implementations +* Making the default glue for HTTP headers ';' instead of ',' +* Adding a removeValue to Guzzle\Http\Message\Header +* Adding getCookies() to request interface. +* Making it easier to add event subscribers to HasDispatcherInterface classes. Can now directly call addSubscriber() + +## 2.6.4 - 2012-05-30 + +* BC: Cleaning up how POST files are stored in EntityEnclosingRequest objects. Adding PostFile class. +* BC: Moving ApiCommand specific functionality from the Inspector and on to the ApiCommand +* Bug: Fixing magic method command calls on clients +* Bug: Email constraint only validates strings +* Bug: Aggregate POST fields when POST files are present in curl handle +* Bug: Fixing default User-Agent header +* Bug: Only appending or prepending parameters in commands if they are specified +* Bug: Not requiring response reason phrases or status codes to match a predefined list of codes +* Allowing the use of dot notation for class namespaces when using instance_of constraint +* Added any_match validation constraint +* Added an AsyncPlugin +* Passing request object to the calculateWait method of the ExponentialBackoffPlugin +* Allowing the result of a command object to be changed +* Parsing location and type sub values when instantiating a service description rather than over and over at runtime + +## 2.6.3 - 2012-05-23 + +* [BC] Guzzle\Common\FromConfigInterface no longer requires any config options. +* [BC] Refactoring how POST files are stored on an EntityEnclosingRequest. They are now separate from POST fields. +* You can now use an array of data when creating PUT request bodies in the request factory. +* Removing the requirement that HTTPS requests needed a Cache-Control: public directive to be cacheable. +* [Http] Adding support for Content-Type in multipart POST uploads per upload +* [Http] Added support for uploading multiple files using the same name (foo[0], foo[1]) +* Adding more POST data operations for easier manipulation of POST data. +* You can now set empty POST fields. +* The body of a request is only shown on EntityEnclosingRequest objects that do not use POST files. +* Split the Guzzle\Service\Inspector::validateConfig method into two methods. One to initialize when a command is created, and one to validate. +* CS updates + +## 2.6.2 - 2012-05-19 + +* [Http] Better handling of nested scope requests in CurlMulti. Requests are now always prepares in the send() method rather than the addRequest() method. + +## 2.6.1 - 2012-05-19 + +* [BC] Removing 'path' support in service descriptions. Use 'uri'. +* [BC] Guzzle\Service\Inspector::parseDocBlock is now protected. Adding getApiParamsForClass() with cache. +* [BC] Removing Guzzle\Common\NullObject. Use https://github.com/mtdowling/NullObject if you need it. +* [BC] Removing Guzzle\Common\XmlElement. +* All commands, both dynamic and concrete, have ApiCommand objects. +* Adding a fix for CurlMulti so that if all of the connections encounter some sort of curl error, then the loop exits. +* Adding checks to EntityEnclosingRequest so that empty POST files and fields are ignored. +* Making the method signature of Guzzle\Service\Builder\ServiceBuilder::factory more flexible. + +## 2.6.0 - 2012-05-15 + +* [BC] Moving Guzzle\Service\Builder to Guzzle\Service\Builder\ServiceBuilder +* [BC] Executing a Command returns the result of the command rather than the command +* [BC] Moving all HTTP parsing logic to Guzzle\Http\Parsers. Allows for faster C implementations if needed. +* [BC] Changing the Guzzle\Http\Message\Response::setProtocol() method to accept a protocol and version in separate args. +* [BC] Moving ResourceIterator* to Guzzle\Service\Resource +* [BC] Completely refactored ResourceIterators to iterate over a cloned command object +* [BC] Moved Guzzle\Http\UriTemplate to Guzzle\Http\Parser\UriTemplate\UriTemplate +* [BC] Guzzle\Guzzle is now deprecated +* Moving Guzzle\Common\Guzzle::inject to Guzzle\Common\Collection::inject +* Adding Guzzle\Version class to give version information about Guzzle +* Adding Guzzle\Http\Utils class to provide getDefaultUserAgent() and getHttpDate() +* Adding Guzzle\Curl\CurlVersion to manage caching curl_version() data +* ServiceDescription and ServiceBuilder are now cacheable using similar configs +* Changing the format of XML and JSON service builder configs. Backwards compatible. +* Cleaned up Cookie parsing +* Trimming the default Guzzle User-Agent header +* Adding a setOnComplete() method to Commands that is called when a command completes +* Keeping track of requests that were mocked in the MockPlugin +* Fixed a caching bug in the CacheAdapterFactory +* Inspector objects can be injected into a Command object +* Refactoring a lot of code and tests to be case insensitive when dealing with headers +* Adding Guzzle\Http\Message\HeaderComparison for easy comparison of HTTP headers using a DSL +* Adding the ability to set global option overrides to service builder configs +* Adding the ability to include other service builder config files from within XML and JSON files +* Moving the parseQuery method out of Url and on to QueryString::fromString() as a static factory method. + +## 2.5.0 - 2012-05-08 + +* Major performance improvements +* [BC] Simplifying Guzzle\Common\Collection. Please check to see if you are using features that are now deprecated. +* [BC] Using a custom validation system that allows a flyweight implementation for much faster validation. No longer using Symfony2 Validation component. +* [BC] No longer supporting "{{ }}" for injecting into command or UriTemplates. Use "{}" +* Added the ability to passed parameters to all requests created by a client +* Added callback functionality to the ExponentialBackoffPlugin +* Using microtime in ExponentialBackoffPlugin to allow more granular backoff strategies. +* Rewinding request stream bodies when retrying requests +* Exception is thrown when JSON response body cannot be decoded +* Added configurable magic method calls to clients and commands. This is off by default. +* Fixed a defect that added a hash to every parsed URL part +* Fixed duplicate none generation for OauthPlugin. +* Emitting an event each time a client is generated by a ServiceBuilder +* Using an ApiParams object instead of a Collection for parameters of an ApiCommand +* cache.* request parameters should be renamed to params.cache.* +* Added the ability to set arbitrary curl options on requests (disable_wire, progress, etc.). See CurlHandle. +* Added the ability to disable type validation of service descriptions +* ServiceDescriptions and ServiceBuilders are now Serializable diff --git a/lib/guzzlehttp/guzzle/LICENSE b/lib/guzzlehttp/guzzle/LICENSE new file mode 100644 index 00000000..fd2375d8 --- /dev/null +++ b/lib/guzzlehttp/guzzle/LICENSE @@ -0,0 +1,27 @@ +The MIT License (MIT) + +Copyright (c) 2011 Michael Dowling +Copyright (c) 2012 Jeremy Lindblom +Copyright (c) 2014 Graham Campbell +Copyright (c) 2015 Márk Sági-Kazár +Copyright (c) 2015 Tobias Schultze +Copyright (c) 2016 Tobias Nyholm +Copyright (c) 2016 George Mponos + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/lib/guzzlehttp/guzzle/README.md b/lib/guzzlehttp/guzzle/README.md new file mode 100644 index 00000000..0025aa7a --- /dev/null +++ b/lib/guzzlehttp/guzzle/README.md @@ -0,0 +1,94 @@ +![Guzzle](.github/logo.png?raw=true) + +# Guzzle, PHP HTTP client + +[![Latest Version](https://img.shields.io/github/release/guzzle/guzzle.svg?style=flat-square)](https://github.com/guzzle/guzzle/releases) +[![Build Status](https://img.shields.io/github/workflow/status/guzzle/guzzle/CI?label=ci%20build&style=flat-square)](https://github.com/guzzle/guzzle/actions?query=workflow%3ACI) +[![Total Downloads](https://img.shields.io/packagist/dt/guzzlehttp/guzzle.svg?style=flat-square)](https://packagist.org/packages/guzzlehttp/guzzle) + +Guzzle is a PHP HTTP client that makes it easy to send HTTP requests and +trivial to integrate with web services. + +- Simple interface for building query strings, POST requests, streaming large + uploads, streaming large downloads, using HTTP cookies, uploading JSON data, + etc... +- Can send both synchronous and asynchronous requests using the same interface. +- Uses PSR-7 interfaces for requests, responses, and streams. This allows you + to utilize other PSR-7 compatible libraries with Guzzle. +- Supports PSR-18 allowing interoperability between other PSR-18 HTTP Clients. +- Abstracts away the underlying HTTP transport, allowing you to write + environment and transport agnostic code; i.e., no hard dependency on cURL, + PHP streams, sockets, or non-blocking event loops. +- Middleware system allows you to augment and compose client behavior. + +```php +$client = new \GuzzleHttp\Client(); +$response = $client->request('GET', 'https://api.github.com/repos/guzzle/guzzle'); + +echo $response->getStatusCode(); // 200 +echo $response->getHeaderLine('content-type'); // 'application/json; charset=utf8' +echo $response->getBody(); // '{"id": 1420053, "name": "guzzle", ...}' + +// Send an asynchronous request. +$request = new \GuzzleHttp\Psr7\Request('GET', 'http://httpbin.org'); +$promise = $client->sendAsync($request)->then(function ($response) { + echo 'I completed! ' . $response->getBody(); +}); + +$promise->wait(); +``` + +## Help and docs + +We use GitHub issues only to discuss bugs and new features. For support please refer to: + +- [Documentation](http://guzzlephp.org/) +- [Stack Overflow](http://stackoverflow.com/questions/tagged/guzzle) +- [#guzzle](https://app.slack.com/client/T0D2S9JCT/CE6UAAKL4) channel on [PHP-HTTP Slack](http://slack.httplug.io/) +- [Gitter](https://gitter.im/guzzle/guzzle) + + +## Installing Guzzle + +The recommended way to install Guzzle is through +[Composer](https://getcomposer.org/). + +```bash +composer require guzzlehttp/guzzle +``` + + +## Version Guidance + +| Version | Status | Packagist | Namespace | Repo | Docs | PSR-7 | PHP Version | +|---------|------------|---------------------|--------------|---------------------|---------------------|-------|-------------| +| 3.x | EOL | `guzzle/guzzle` | `Guzzle` | [v3][guzzle-3-repo] | [v3][guzzle-3-docs] | No | >= 5.3.3 | +| 4.x | EOL | `guzzlehttp/guzzle` | `GuzzleHttp` | [v4][guzzle-4-repo] | N/A | No | >= 5.4 | +| 5.x | EOL | `guzzlehttp/guzzle` | `GuzzleHttp` | [v5][guzzle-5-repo] | [v5][guzzle-5-docs] | No | >= 5.4 | +| 6.x | Security fixes | `guzzlehttp/guzzle` | `GuzzleHttp` | [v6][guzzle-6-repo] | [v6][guzzle-6-docs] | Yes | >= 5.5 | +| 7.x | Latest | `guzzlehttp/guzzle` | `GuzzleHttp` | [v7][guzzle-7-repo] | [v7][guzzle-7-docs] | Yes | >= 7.2 | + +[guzzle-3-repo]: https://github.com/guzzle/guzzle3 +[guzzle-4-repo]: https://github.com/guzzle/guzzle/tree/4.x +[guzzle-5-repo]: https://github.com/guzzle/guzzle/tree/5.3 +[guzzle-6-repo]: https://github.com/guzzle/guzzle/tree/6.5 +[guzzle-7-repo]: https://github.com/guzzle/guzzle +[guzzle-3-docs]: http://guzzle3.readthedocs.org +[guzzle-5-docs]: http://docs.guzzlephp.org/en/5.3/ +[guzzle-6-docs]: http://docs.guzzlephp.org/en/6.5/ +[guzzle-7-docs]: http://docs.guzzlephp.org/en/latest/ + + +## Security + +If you discover a security vulnerability within this package, please send an email to security@tidelift.com. All security vulnerabilities will be promptly addressed. Please do not disclose security-related issues publicly until a fix has been announced. Please see [Security Policy](https://github.com/guzzle/guzzle/security/policy) for more information. + +## License + +Guzzle is made available under the MIT License (MIT). Please see [License File](LICENSE) for more information. + +## For Enterprise + +Available as part of the Tidelift Subscription + +The maintainers of Guzzle and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. [Learn more.](https://tidelift.com/subscription/pkg/packagist-guzzlehttp-guzzle?utm_source=packagist-guzzlehttp-guzzle&utm_medium=referral&utm_campaign=enterprise&utm_term=repo) diff --git a/lib/guzzlehttp/guzzle/UPGRADING.md b/lib/guzzlehttp/guzzle/UPGRADING.md new file mode 100644 index 00000000..45417a7e --- /dev/null +++ b/lib/guzzlehttp/guzzle/UPGRADING.md @@ -0,0 +1,1253 @@ +Guzzle Upgrade Guide +==================== + +6.0 to 7.0 +---------- + +In order to take advantage of the new features of PHP, Guzzle dropped the support +of PHP 5. The minimum supported PHP version is now PHP 7.2. Type hints and return +types for functions and methods have been added wherever possible. + +Please make sure: +- You are calling a function or a method with the correct type. +- If you extend a class of Guzzle; update all signatures on methods you override. + +#### Other backwards compatibility breaking changes + +- Class `GuzzleHttp\UriTemplate` is removed. +- Class `GuzzleHttp\Exception\SeekException` is removed. +- Classes `GuzzleHttp\Exception\BadResponseException`, `GuzzleHttp\Exception\ClientException`, + `GuzzleHttp\Exception\ServerException` can no longer be initialized with an empty + Response as argument. +- Class `GuzzleHttp\Exception\ConnectException` now extends `GuzzleHttp\Exception\TransferException` + instead of `GuzzleHttp\Exception\RequestException`. +- Function `GuzzleHttp\Exception\ConnectException::getResponse()` is removed. +- Function `GuzzleHttp\Exception\ConnectException::hasResponse()` is removed. +- Constant `GuzzleHttp\ClientInterface::VERSION` is removed. Added `GuzzleHttp\ClientInterface::MAJOR_VERSION` instead. +- Function `GuzzleHttp\Exception\RequestException::getResponseBodySummary` is removed. + Use `\GuzzleHttp\Psr7\get_message_body_summary` as an alternative. +- Function `GuzzleHttp\Cookie\CookieJar::getCookieValue` is removed. +- Request option `exception` is removed. Please use `http_errors`. +- Request option `save_to` is removed. Please use `sink`. +- Pool option `pool_size` is removed. Please use `concurrency`. +- We now look for environment variables in the `$_SERVER` super global, due to thread safety issues with `getenv`. We continue to fallback to `getenv` in CLI environments, for maximum compatibility. +- The `get`, `head`, `put`, `post`, `patch`, `delete`, `getAsync`, `headAsync`, `putAsync`, `postAsync`, `patchAsync`, and `deleteAsync` methods are now implemented as genuine methods on `GuzzleHttp\Client`, with strong typing. The original `__call` implementation remains unchanged for now, for maximum backwards compatibility, but won't be invoked under normal operation. +- The `log` middleware will log the errors with level `error` instead of `notice` +- Support for international domain names (IDN) is now disabled by default, and enabling it requires installing ext-intl, linked against a modern version of the C library (ICU 4.6 or higher). + +#### Native functions calls + +All internal native functions calls of Guzzle are now prefixed with a slash. This +change makes it impossible for method overloading by other libraries or applications. +Example: + +```php +// Before: +curl_version(); + +// After: +\curl_version(); +``` + +For the full diff you can check [here](https://github.com/guzzle/guzzle/compare/6.5.4..master). + +5.0 to 6.0 +---------- + +Guzzle now uses [PSR-7](https://www.php-fig.org/psr/psr-7/) for HTTP messages. +Due to the fact that these messages are immutable, this prompted a refactoring +of Guzzle to use a middleware based system rather than an event system. Any +HTTP message interaction (e.g., `GuzzleHttp\Message\Request`) need to be +updated to work with the new immutable PSR-7 request and response objects. Any +event listeners or subscribers need to be updated to become middleware +functions that wrap handlers (or are injected into a +`GuzzleHttp\HandlerStack`). + +- Removed `GuzzleHttp\BatchResults` +- Removed `GuzzleHttp\Collection` +- Removed `GuzzleHttp\HasDataTrait` +- Removed `GuzzleHttp\ToArrayInterface` +- The `guzzlehttp/streams` dependency has been removed. Stream functionality + is now present in the `GuzzleHttp\Psr7` namespace provided by the + `guzzlehttp/psr7` package. +- Guzzle no longer uses ReactPHP promises and now uses the + `guzzlehttp/promises` library. We use a custom promise library for three + significant reasons: + 1. React promises (at the time of writing this) are recursive. Promise + chaining and promise resolution will eventually blow the stack. Guzzle + promises are not recursive as they use a sort of trampolining technique. + Note: there has been movement in the React project to modify promises to + no longer utilize recursion. + 2. Guzzle needs to have the ability to synchronously block on a promise to + wait for a result. Guzzle promises allows this functionality (and does + not require the use of recursion). + 3. Because we need to be able to wait on a result, doing so using React + promises requires wrapping react promises with RingPHP futures. This + overhead is no longer needed, reducing stack sizes, reducing complexity, + and improving performance. +- `GuzzleHttp\Mimetypes` has been moved to a function in + `GuzzleHttp\Psr7\mimetype_from_extension` and + `GuzzleHttp\Psr7\mimetype_from_filename`. +- `GuzzleHttp\Query` and `GuzzleHttp\QueryParser` have been removed. Query + strings must now be passed into request objects as strings, or provided to + the `query` request option when creating requests with clients. The `query` + option uses PHP's `http_build_query` to convert an array to a string. If you + need a different serialization technique, you will need to pass the query + string in as a string. There are a couple helper functions that will make + working with query strings easier: `GuzzleHttp\Psr7\parse_query` and + `GuzzleHttp\Psr7\build_query`. +- Guzzle no longer has a dependency on RingPHP. Due to the use of a middleware + system based on PSR-7, using RingPHP and it's middleware system as well adds + more complexity than the benefits it provides. All HTTP handlers that were + present in RingPHP have been modified to work directly with PSR-7 messages + and placed in the `GuzzleHttp\Handler` namespace. This significantly reduces + complexity in Guzzle, removes a dependency, and improves performance. RingPHP + will be maintained for Guzzle 5 support, but will no longer be a part of + Guzzle 6. +- As Guzzle now uses a middleware based systems the event system and RingPHP + integration has been removed. Note: while the event system has been removed, + it is possible to add your own type of event system that is powered by the + middleware system. + - Removed the `Event` namespace. + - Removed the `Subscriber` namespace. + - Removed `Transaction` class + - Removed `RequestFsm` + - Removed `RingBridge` + - `GuzzleHttp\Subscriber\Cookie` is now provided by + `GuzzleHttp\Middleware::cookies` + - `GuzzleHttp\Subscriber\HttpError` is now provided by + `GuzzleHttp\Middleware::httpError` + - `GuzzleHttp\Subscriber\History` is now provided by + `GuzzleHttp\Middleware::history` + - `GuzzleHttp\Subscriber\Mock` is now provided by + `GuzzleHttp\Handler\MockHandler` + - `GuzzleHttp\Subscriber\Prepare` is now provided by + `GuzzleHttp\PrepareBodyMiddleware` + - `GuzzleHttp\Subscriber\Redirect` is now provided by + `GuzzleHttp\RedirectMiddleware` +- Guzzle now uses `Psr\Http\Message\UriInterface` (implements in + `GuzzleHttp\Psr7\Uri`) for URI support. `GuzzleHttp\Url` is now gone. +- Static functions in `GuzzleHttp\Utils` have been moved to namespaced + functions under the `GuzzleHttp` namespace. This requires either a Composer + based autoloader or you to include functions.php. +- `GuzzleHttp\ClientInterface::getDefaultOption` has been renamed to + `GuzzleHttp\ClientInterface::getConfig`. +- `GuzzleHttp\ClientInterface::setDefaultOption` has been removed. +- The `json` and `xml` methods of response objects has been removed. With the + migration to strictly adhering to PSR-7 as the interface for Guzzle messages, + adding methods to message interfaces would actually require Guzzle messages + to extend from PSR-7 messages rather then work with them directly. + +## Migrating to middleware + +The change to PSR-7 unfortunately required significant refactoring to Guzzle +due to the fact that PSR-7 messages are immutable. Guzzle 5 relied on an event +system from plugins. The event system relied on mutability of HTTP messages and +side effects in order to work. With immutable messages, you have to change your +workflow to become more about either returning a value (e.g., functional +middlewares) or setting a value on an object. Guzzle v6 has chosen the +functional middleware approach. + +Instead of using the event system to listen for things like the `before` event, +you now create a stack based middleware function that intercepts a request on +the way in and the promise of the response on the way out. This is a much +simpler and more predictable approach than the event system and works nicely +with PSR-7 middleware. Due to the use of promises, the middleware system is +also asynchronous. + +v5: + +```php +use GuzzleHttp\Event\BeforeEvent; +$client = new GuzzleHttp\Client(); +// Get the emitter and listen to the before event. +$client->getEmitter()->on('before', function (BeforeEvent $e) { + // Guzzle v5 events relied on mutation + $e->getRequest()->setHeader('X-Foo', 'Bar'); +}); +``` + +v6: + +In v6, you can modify the request before it is sent using the `mapRequest` +middleware. The idiomatic way in v6 to modify the request/response lifecycle is +to setup a handler middleware stack up front and inject the handler into a +client. + +```php +use GuzzleHttp\Middleware; +// Create a handler stack that has all of the default middlewares attached +$handler = GuzzleHttp\HandlerStack::create(); +// Push the handler onto the handler stack +$handler->push(Middleware::mapRequest(function (RequestInterface $request) { + // Notice that we have to return a request object + return $request->withHeader('X-Foo', 'Bar'); +})); +// Inject the handler into the client +$client = new GuzzleHttp\Client(['handler' => $handler]); +``` + +## POST Requests + +This version added the [`form_params`](http://guzzle.readthedocs.org/en/latest/request-options.html#form_params) +and `multipart` request options. `form_params` is an associative array of +strings or array of strings and is used to serialize an +`application/x-www-form-urlencoded` POST request. The +[`multipart`](http://guzzle.readthedocs.org/en/latest/request-options.html#multipart) +option is now used to send a multipart/form-data POST request. + +`GuzzleHttp\Post\PostFile` has been removed. Use the `multipart` option to add +POST files to a multipart/form-data request. + +The `body` option no longer accepts an array to send POST requests. Please use +`multipart` or `form_params` instead. + +The `base_url` option has been renamed to `base_uri`. + +4.x to 5.0 +---------- + +## Rewritten Adapter Layer + +Guzzle now uses [RingPHP](http://ringphp.readthedocs.org/en/latest) to send +HTTP requests. The `adapter` option in a `GuzzleHttp\Client` constructor +is still supported, but it has now been renamed to `handler`. Instead of +passing a `GuzzleHttp\Adapter\AdapterInterface`, you must now pass a PHP +`callable` that follows the RingPHP specification. + +## Removed Fluent Interfaces + +[Fluent interfaces were removed](https://ocramius.github.io/blog/fluent-interfaces-are-evil/) +from the following classes: + +- `GuzzleHttp\Collection` +- `GuzzleHttp\Url` +- `GuzzleHttp\Query` +- `GuzzleHttp\Post\PostBody` +- `GuzzleHttp\Cookie\SetCookie` + +## Removed functions.php + +Removed "functions.php", so that Guzzle is truly PSR-4 compliant. The following +functions can be used as replacements. + +- `GuzzleHttp\json_decode` -> `GuzzleHttp\Utils::jsonDecode` +- `GuzzleHttp\get_path` -> `GuzzleHttp\Utils::getPath` +- `GuzzleHttp\Utils::setPath` -> `GuzzleHttp\set_path` +- `GuzzleHttp\Pool::batch` -> `GuzzleHttp\batch`. This function is, however, + deprecated in favor of using `GuzzleHttp\Pool::batch()`. + +The "procedural" global client has been removed with no replacement (e.g., +`GuzzleHttp\get()`, `GuzzleHttp\post()`, etc.). Use a `GuzzleHttp\Client` +object as a replacement. + +## `throwImmediately` has been removed + +The concept of "throwImmediately" has been removed from exceptions and error +events. This control mechanism was used to stop a transfer of concurrent +requests from completing. This can now be handled by throwing the exception or +by cancelling a pool of requests or each outstanding future request +individually. + +## headers event has been removed + +Removed the "headers" event. This event was only useful for changing the +body a response once the headers of the response were known. You can implement +a similar behavior in a number of ways. One example might be to use a +FnStream that has access to the transaction being sent. For example, when the +first byte is written, you could check if the response headers match your +expectations, and if so, change the actual stream body that is being +written to. + +## Updates to HTTP Messages + +Removed the `asArray` parameter from +`GuzzleHttp\Message\MessageInterface::getHeader`. If you want to get a header +value as an array, then use the newly added `getHeaderAsArray()` method of +`MessageInterface`. This change makes the Guzzle interfaces compatible with +the PSR-7 interfaces. + +3.x to 4.0 +---------- + +## Overarching changes: + +- Now requires PHP 5.4 or greater. +- No longer requires cURL to send requests. +- Guzzle no longer wraps every exception it throws. Only exceptions that are + recoverable are now wrapped by Guzzle. +- Various namespaces have been removed or renamed. +- No longer requiring the Symfony EventDispatcher. A custom event dispatcher + based on the Symfony EventDispatcher is + now utilized in `GuzzleHttp\Event\EmitterInterface` (resulting in significant + speed and functionality improvements). + +Changes per Guzzle 3.x namespace are described below. + +## Batch + +The `Guzzle\Batch` namespace has been removed. This is best left to +third-parties to implement on top of Guzzle's core HTTP library. + +## Cache + +The `Guzzle\Cache` namespace has been removed. (Todo: No suitable replacement +has been implemented yet, but hoping to utilize a PSR cache interface). + +## Common + +- Removed all of the wrapped exceptions. It's better to use the standard PHP + library for unrecoverable exceptions. +- `FromConfigInterface` has been removed. +- `Guzzle\Common\Version` has been removed. The VERSION constant can be found + at `GuzzleHttp\ClientInterface::VERSION`. + +### Collection + +- `getAll` has been removed. Use `toArray` to convert a collection to an array. +- `inject` has been removed. +- `keySearch` has been removed. +- `getPath` no longer supports wildcard expressions. Use something better like + JMESPath for this. +- `setPath` now supports appending to an existing array via the `[]` notation. + +### Events + +Guzzle no longer requires Symfony's EventDispatcher component. Guzzle now uses +`GuzzleHttp\Event\Emitter`. + +- `Symfony\Component\EventDispatcher\EventDispatcherInterface` is replaced by + `GuzzleHttp\Event\EmitterInterface`. +- `Symfony\Component\EventDispatcher\EventDispatcher` is replaced by + `GuzzleHttp\Event\Emitter`. +- `Symfony\Component\EventDispatcher\Event` is replaced by + `GuzzleHttp\Event\Event`, and Guzzle now has an EventInterface in + `GuzzleHttp\Event\EventInterface`. +- `AbstractHasDispatcher` has moved to a trait, `HasEmitterTrait`, and + `HasDispatcherInterface` has moved to `HasEmitterInterface`. Retrieving the + event emitter of a request, client, etc. now uses the `getEmitter` method + rather than the `getDispatcher` method. + +#### Emitter + +- Use the `once()` method to add a listener that automatically removes itself + the first time it is invoked. +- Use the `listeners()` method to retrieve a list of event listeners rather than + the `getListeners()` method. +- Use `emit()` instead of `dispatch()` to emit an event from an emitter. +- Use `attach()` instead of `addSubscriber()` and `detach()` instead of + `removeSubscriber()`. + +```php +$mock = new Mock(); +// 3.x +$request->getEventDispatcher()->addSubscriber($mock); +$request->getEventDispatcher()->removeSubscriber($mock); +// 4.x +$request->getEmitter()->attach($mock); +$request->getEmitter()->detach($mock); +``` + +Use the `on()` method to add a listener rather than the `addListener()` method. + +```php +// 3.x +$request->getEventDispatcher()->addListener('foo', function (Event $event) { /* ... */ } ); +// 4.x +$request->getEmitter()->on('foo', function (Event $event, $name) { /* ... */ } ); +``` + +## Http + +### General changes + +- The cacert.pem certificate has been moved to `src/cacert.pem`. +- Added the concept of adapters that are used to transfer requests over the + wire. +- Simplified the event system. +- Sending requests in parallel is still possible, but batching is no longer a + concept of the HTTP layer. Instead, you must use the `complete` and `error` + events to asynchronously manage parallel request transfers. +- `Guzzle\Http\Url` has moved to `GuzzleHttp\Url`. +- `Guzzle\Http\QueryString` has moved to `GuzzleHttp\Query`. +- QueryAggregators have been rewritten so that they are simply callable + functions. +- `GuzzleHttp\StaticClient` has been removed. Use the functions provided in + `functions.php` for an easy to use static client instance. +- Exceptions in `GuzzleHttp\Exception` have been updated to all extend from + `GuzzleHttp\Exception\TransferException`. + +### Client + +Calling methods like `get()`, `post()`, `head()`, etc. no longer create and +return a request, but rather creates a request, sends the request, and returns +the response. + +```php +// 3.0 +$request = $client->get('/'); +$response = $request->send(); + +// 4.0 +$response = $client->get('/'); + +// or, to mirror the previous behavior +$request = $client->createRequest('GET', '/'); +$response = $client->send($request); +``` + +`GuzzleHttp\ClientInterface` has changed. + +- The `send` method no longer accepts more than one request. Use `sendAll` to + send multiple requests in parallel. +- `setUserAgent()` has been removed. Use a default request option instead. You + could, for example, do something like: + `$client->setConfig('defaults/headers/User-Agent', 'Foo/Bar ' . $client::getDefaultUserAgent())`. +- `setSslVerification()` has been removed. Use default request options instead, + like `$client->setConfig('defaults/verify', true)`. + +`GuzzleHttp\Client` has changed. + +- The constructor now accepts only an associative array. You can include a + `base_url` string or array to use a URI template as the base URL of a client. + You can also specify a `defaults` key that is an associative array of default + request options. You can pass an `adapter` to use a custom adapter, + `batch_adapter` to use a custom adapter for sending requests in parallel, or + a `message_factory` to change the factory used to create HTTP requests and + responses. +- The client no longer emits a `client.create_request` event. +- Creating requests with a client no longer automatically utilize a URI + template. You must pass an array into a creational method (e.g., + `createRequest`, `get`, `put`, etc.) in order to expand a URI template. + +### Messages + +Messages no longer have references to their counterparts (i.e., a request no +longer has a reference to it's response, and a response no loger has a +reference to its request). This association is now managed through a +`GuzzleHttp\Adapter\TransactionInterface` object. You can get references to +these transaction objects using request events that are emitted over the +lifecycle of a request. + +#### Requests with a body + +- `GuzzleHttp\Message\EntityEnclosingRequest` and + `GuzzleHttp\Message\EntityEnclosingRequestInterface` have been removed. The + separation between requests that contain a body and requests that do not + contain a body has been removed, and now `GuzzleHttp\Message\RequestInterface` + handles both use cases. +- Any method that previously accepts a `GuzzleHttp\Response` object now accept a + `GuzzleHttp\Message\ResponseInterface`. +- `GuzzleHttp\Message\RequestFactoryInterface` has been renamed to + `GuzzleHttp\Message\MessageFactoryInterface`. This interface is used to create + both requests and responses and is implemented in + `GuzzleHttp\Message\MessageFactory`. +- POST field and file methods have been removed from the request object. You + must now use the methods made available to `GuzzleHttp\Post\PostBodyInterface` + to control the format of a POST body. Requests that are created using a + standard `GuzzleHttp\Message\MessageFactoryInterface` will automatically use + a `GuzzleHttp\Post\PostBody` body if the body was passed as an array or if + the method is POST and no body is provided. + +```php +$request = $client->createRequest('POST', '/'); +$request->getBody()->setField('foo', 'bar'); +$request->getBody()->addFile(new PostFile('file_key', fopen('/path/to/content', 'r'))); +``` + +#### Headers + +- `GuzzleHttp\Message\Header` has been removed. Header values are now simply + represented by an array of values or as a string. Header values are returned + as a string by default when retrieving a header value from a message. You can + pass an optional argument of `true` to retrieve a header value as an array + of strings instead of a single concatenated string. +- `GuzzleHttp\PostFile` and `GuzzleHttp\PostFileInterface` have been moved to + `GuzzleHttp\Post`. This interface has been simplified and now allows the + addition of arbitrary headers. +- Custom headers like `GuzzleHttp\Message\Header\Link` have been removed. Most + of the custom headers are now handled separately in specific + subscribers/plugins, and `GuzzleHttp\Message\HeaderValues::parseParams()` has + been updated to properly handle headers that contain parameters (like the + `Link` header). + +#### Responses + +- `GuzzleHttp\Message\Response::getInfo()` and + `GuzzleHttp\Message\Response::setInfo()` have been removed. Use the event + system to retrieve this type of information. +- `GuzzleHttp\Message\Response::getRawHeaders()` has been removed. +- `GuzzleHttp\Message\Response::getMessage()` has been removed. +- `GuzzleHttp\Message\Response::calculateAge()` and other cache specific + methods have moved to the CacheSubscriber. +- Header specific helper functions like `getContentMd5()` have been removed. + Just use `getHeader('Content-MD5')` instead. +- `GuzzleHttp\Message\Response::setRequest()` and + `GuzzleHttp\Message\Response::getRequest()` have been removed. Use the event + system to work with request and response objects as a transaction. +- `GuzzleHttp\Message\Response::getRedirectCount()` has been removed. Use the + Redirect subscriber instead. +- `GuzzleHttp\Message\Response::isSuccessful()` and other related methods have + been removed. Use `getStatusCode()` instead. + +#### Streaming responses + +Streaming requests can now be created by a client directly, returning a +`GuzzleHttp\Message\ResponseInterface` object that contains a body stream +referencing an open PHP HTTP stream. + +```php +// 3.0 +use Guzzle\Stream\PhpStreamRequestFactory; +$request = $client->get('/'); +$factory = new PhpStreamRequestFactory(); +$stream = $factory->fromRequest($request); +$data = $stream->read(1024); + +// 4.0 +$response = $client->get('/', ['stream' => true]); +// Read some data off of the stream in the response body +$data = $response->getBody()->read(1024); +``` + +#### Redirects + +The `configureRedirects()` method has been removed in favor of a +`allow_redirects` request option. + +```php +// Standard redirects with a default of a max of 5 redirects +$request = $client->createRequest('GET', '/', ['allow_redirects' => true]); + +// Strict redirects with a custom number of redirects +$request = $client->createRequest('GET', '/', [ + 'allow_redirects' => ['max' => 5, 'strict' => true] +]); +``` + +#### EntityBody + +EntityBody interfaces and classes have been removed or moved to +`GuzzleHttp\Stream`. All classes and interfaces that once required +`GuzzleHttp\EntityBodyInterface` now require +`GuzzleHttp\Stream\StreamInterface`. Creating a new body for a request no +longer uses `GuzzleHttp\EntityBody::factory` but now uses +`GuzzleHttp\Stream\Stream::factory` or even better: +`GuzzleHttp\Stream\create()`. + +- `Guzzle\Http\EntityBodyInterface` is now `GuzzleHttp\Stream\StreamInterface` +- `Guzzle\Http\EntityBody` is now `GuzzleHttp\Stream\Stream` +- `Guzzle\Http\CachingEntityBody` is now `GuzzleHttp\Stream\CachingStream` +- `Guzzle\Http\ReadLimitEntityBody` is now `GuzzleHttp\Stream\LimitStream` +- `Guzzle\Http\IoEmittyinEntityBody` has been removed. + +#### Request lifecycle events + +Requests previously submitted a large number of requests. The number of events +emitted over the lifecycle of a request has been significantly reduced to make +it easier to understand how to extend the behavior of a request. All events +emitted during the lifecycle of a request now emit a custom +`GuzzleHttp\Event\EventInterface` object that contains context providing +methods and a way in which to modify the transaction at that specific point in +time (e.g., intercept the request and set a response on the transaction). + +- `request.before_send` has been renamed to `before` and now emits a + `GuzzleHttp\Event\BeforeEvent` +- `request.complete` has been renamed to `complete` and now emits a + `GuzzleHttp\Event\CompleteEvent`. +- `request.sent` has been removed. Use `complete`. +- `request.success` has been removed. Use `complete`. +- `error` is now an event that emits a `GuzzleHttp\Event\ErrorEvent`. +- `request.exception` has been removed. Use `error`. +- `request.receive.status_line` has been removed. +- `curl.callback.progress` has been removed. Use a custom `StreamInterface` to + maintain a status update. +- `curl.callback.write` has been removed. Use a custom `StreamInterface` to + intercept writes. +- `curl.callback.read` has been removed. Use a custom `StreamInterface` to + intercept reads. + +`headers` is a new event that is emitted after the response headers of a +request have been received before the body of the response is downloaded. This +event emits a `GuzzleHttp\Event\HeadersEvent`. + +You can intercept a request and inject a response using the `intercept()` event +of a `GuzzleHttp\Event\BeforeEvent`, `GuzzleHttp\Event\CompleteEvent`, and +`GuzzleHttp\Event\ErrorEvent` event. + +See: http://docs.guzzlephp.org/en/latest/events.html + +## Inflection + +The `Guzzle\Inflection` namespace has been removed. This is not a core concern +of Guzzle. + +## Iterator + +The `Guzzle\Iterator` namespace has been removed. + +- `Guzzle\Iterator\AppendIterator`, `Guzzle\Iterator\ChunkedIterator`, and + `Guzzle\Iterator\MethodProxyIterator` are nice, but not a core requirement of + Guzzle itself. +- `Guzzle\Iterator\FilterIterator` is no longer needed because an equivalent + class is shipped with PHP 5.4. +- `Guzzle\Iterator\MapIterator` is not really needed when using PHP 5.5 because + it's easier to just wrap an iterator in a generator that maps values. + +For a replacement of these iterators, see https://github.com/nikic/iter + +## Log + +The LogPlugin has moved to https://github.com/guzzle/log-subscriber. The +`Guzzle\Log` namespace has been removed. Guzzle now relies on +`Psr\Log\LoggerInterface` for all logging. The MessageFormatter class has been +moved to `GuzzleHttp\Subscriber\Log\Formatter`. + +## Parser + +The `Guzzle\Parser` namespace has been removed. This was previously used to +make it possible to plug in custom parsers for cookies, messages, URI +templates, and URLs; however, this level of complexity is not needed in Guzzle +so it has been removed. + +- Cookie: Cookie parsing logic has been moved to + `GuzzleHttp\Cookie\SetCookie::fromString`. +- Message: Message parsing logic for both requests and responses has been moved + to `GuzzleHttp\Message\MessageFactory::fromMessage`. Message parsing is only + used in debugging or deserializing messages, so it doesn't make sense for + Guzzle as a library to add this level of complexity to parsing messages. +- UriTemplate: URI template parsing has been moved to + `GuzzleHttp\UriTemplate`. The Guzzle library will automatically use the PECL + URI template library if it is installed. +- Url: URL parsing is now performed in `GuzzleHttp\Url::fromString` (previously + it was `Guzzle\Http\Url::factory()`). If custom URL parsing is necessary, + then developers are free to subclass `GuzzleHttp\Url`. + +## Plugin + +The `Guzzle\Plugin` namespace has been renamed to `GuzzleHttp\Subscriber`. +Several plugins are shipping with the core Guzzle library under this namespace. + +- `GuzzleHttp\Subscriber\Cookie`: Replaces the old CookiePlugin. Cookie jar + code has moved to `GuzzleHttp\Cookie`. +- `GuzzleHttp\Subscriber\History`: Replaces the old HistoryPlugin. +- `GuzzleHttp\Subscriber\HttpError`: Throws errors when a bad HTTP response is + received. +- `GuzzleHttp\Subscriber\Mock`: Replaces the old MockPlugin. +- `GuzzleHttp\Subscriber\Prepare`: Prepares the body of a request just before + sending. This subscriber is attached to all requests by default. +- `GuzzleHttp\Subscriber\Redirect`: Replaces the RedirectPlugin. + +The following plugins have been removed (third-parties are free to re-implement +these if needed): + +- `GuzzleHttp\Plugin\Async` has been removed. +- `GuzzleHttp\Plugin\CurlAuth` has been removed. +- `GuzzleHttp\Plugin\ErrorResponse\ErrorResponsePlugin` has been removed. This + functionality should instead be implemented with event listeners that occur + after normal response parsing occurs in the guzzle/command package. + +The following plugins are not part of the core Guzzle package, but are provided +in separate repositories: + +- `Guzzle\Http\Plugin\BackoffPlugin` has been rewritten to be much simpler + to build custom retry policies using simple functions rather than various + chained classes. See: https://github.com/guzzle/retry-subscriber +- `Guzzle\Http\Plugin\Cache\CachePlugin` has moved to + https://github.com/guzzle/cache-subscriber +- `Guzzle\Http\Plugin\Log\LogPlugin` has moved to + https://github.com/guzzle/log-subscriber +- `Guzzle\Http\Plugin\Md5\Md5Plugin` has moved to + https://github.com/guzzle/message-integrity-subscriber +- `Guzzle\Http\Plugin\Mock\MockPlugin` has moved to + `GuzzleHttp\Subscriber\MockSubscriber`. +- `Guzzle\Http\Plugin\Oauth\OauthPlugin` has moved to + https://github.com/guzzle/oauth-subscriber + +## Service + +The service description layer of Guzzle has moved into two separate packages: + +- http://github.com/guzzle/command Provides a high level abstraction over web + services by representing web service operations using commands. +- http://github.com/guzzle/guzzle-services Provides an implementation of + guzzle/command that provides request serialization and response parsing using + Guzzle service descriptions. + +## Stream + +Stream have moved to a separate package available at +https://github.com/guzzle/streams. + +`Guzzle\Stream\StreamInterface` has been given a large update to cleanly take +on the responsibilities of `Guzzle\Http\EntityBody` and +`Guzzle\Http\EntityBodyInterface` now that they have been removed. The number +of methods implemented by the `StreamInterface` has been drastically reduced to +allow developers to more easily extend and decorate stream behavior. + +## Removed methods from StreamInterface + +- `getStream` and `setStream` have been removed to better encapsulate streams. +- `getMetadata` and `setMetadata` have been removed in favor of + `GuzzleHttp\Stream\MetadataStreamInterface`. +- `getWrapper`, `getWrapperData`, `getStreamType`, and `getUri` have all been + removed. This data is accessible when + using streams that implement `GuzzleHttp\Stream\MetadataStreamInterface`. +- `rewind` has been removed. Use `seek(0)` for a similar behavior. + +## Renamed methods + +- `detachStream` has been renamed to `detach`. +- `feof` has been renamed to `eof`. +- `ftell` has been renamed to `tell`. +- `readLine` has moved from an instance method to a static class method of + `GuzzleHttp\Stream\Stream`. + +## Metadata streams + +`GuzzleHttp\Stream\MetadataStreamInterface` has been added to denote streams +that contain additional metadata accessible via `getMetadata()`. +`GuzzleHttp\Stream\StreamInterface::getMetadata` and +`GuzzleHttp\Stream\StreamInterface::setMetadata` have been removed. + +## StreamRequestFactory + +The entire concept of the StreamRequestFactory has been removed. The way this +was used in Guzzle 3 broke the actual interface of sending streaming requests +(instead of getting back a Response, you got a StreamInterface). Streaming +PHP requests are now implemented through the `GuzzleHttp\Adapter\StreamAdapter`. + +3.6 to 3.7 +---------- + +### Deprecations + +- You can now enable E_USER_DEPRECATED warnings to see if you are using any deprecated methods.: + +```php +\Guzzle\Common\Version::$emitWarnings = true; +``` + +The following APIs and options have been marked as deprecated: + +- Marked `Guzzle\Http\Message\Request::isResponseBodyRepeatable()` as deprecated. Use `$request->getResponseBody()->isRepeatable()` instead. +- Marked `Guzzle\Http\Message\Request::canCache()` as deprecated. Use `Guzzle\Plugin\Cache\DefaultCanCacheStrategy->canCacheRequest()` instead. +- Marked `Guzzle\Http\Message\Request::canCache()` as deprecated. Use `Guzzle\Plugin\Cache\DefaultCanCacheStrategy->canCacheRequest()` instead. +- Marked `Guzzle\Http\Message\Request::setIsRedirect()` as deprecated. Use the HistoryPlugin instead. +- Marked `Guzzle\Http\Message\Request::isRedirect()` as deprecated. Use the HistoryPlugin instead. +- Marked `Guzzle\Cache\CacheAdapterFactory::factory()` as deprecated +- Marked `Guzzle\Service\Client::enableMagicMethods()` as deprecated. Magic methods can no longer be disabled on a Guzzle\Service\Client. +- Marked `Guzzle\Parser\Url\UrlParser` as deprecated. Just use PHP's `parse_url()` and percent encode your UTF-8. +- Marked `Guzzle\Common\Collection::inject()` as deprecated. +- Marked `Guzzle\Plugin\CurlAuth\CurlAuthPlugin` as deprecated. Use + `$client->getConfig()->setPath('request.options/auth', array('user', 'pass', 'Basic|Digest|NTLM|Any'));` or + `$client->setDefaultOption('auth', array('user', 'pass', 'Basic|Digest|NTLM|Any'));` + +3.7 introduces `request.options` as a parameter for a client configuration and as an optional argument to all creational +request methods. When paired with a client's configuration settings, these options allow you to specify default settings +for various aspects of a request. Because these options make other previous configuration options redundant, several +configuration options and methods of a client and AbstractCommand have been deprecated. + +- Marked `Guzzle\Service\Client::getDefaultHeaders()` as deprecated. Use `$client->getDefaultOption('headers')`. +- Marked `Guzzle\Service\Client::setDefaultHeaders()` as deprecated. Use `$client->setDefaultOption('headers/{header_name}', 'value')`. +- Marked 'request.params' for `Guzzle\Http\Client` as deprecated. Use `$client->setDefaultOption('params/{param_name}', 'value')` +- Marked 'command.headers', 'command.response_body' and 'command.on_complete' as deprecated for AbstractCommand. These will work through Guzzle 4.0 + + $command = $client->getCommand('foo', array( + 'command.headers' => array('Test' => '123'), + 'command.response_body' => '/path/to/file' + )); + + // Should be changed to: + + $command = $client->getCommand('foo', array( + 'command.request_options' => array( + 'headers' => array('Test' => '123'), + 'save_as' => '/path/to/file' + ) + )); + +### Interface changes + +Additions and changes (you will need to update any implementations or subclasses you may have created): + +- Added an `$options` argument to the end of the following methods of `Guzzle\Http\ClientInterface`: + createRequest, head, delete, put, patch, post, options, prepareRequest +- Added an `$options` argument to the end of `Guzzle\Http\Message\Request\RequestFactoryInterface::createRequest()` +- Added an `applyOptions()` method to `Guzzle\Http\Message\Request\RequestFactoryInterface` +- Changed `Guzzle\Http\ClientInterface::get($uri = null, $headers = null, $body = null)` to + `Guzzle\Http\ClientInterface::get($uri = null, $headers = null, $options = array())`. You can still pass in a + resource, string, or EntityBody into the $options parameter to specify the download location of the response. +- Changed `Guzzle\Common\Collection::__construct($data)` to no longer accepts a null value for `$data` but a + default `array()` +- Added `Guzzle\Stream\StreamInterface::isRepeatable` +- Made `Guzzle\Http\Client::expandTemplate` and `getUriTemplate` protected methods. + +The following methods were removed from interfaces. All of these methods are still available in the concrete classes +that implement them, but you should update your code to use alternative methods: + +- Removed `Guzzle\Http\ClientInterface::setDefaultHeaders(). Use + `$client->getConfig()->setPath('request.options/headers/{header_name}', 'value')`. or + `$client->getConfig()->setPath('request.options/headers', array('header_name' => 'value'))` or + `$client->setDefaultOption('headers/{header_name}', 'value')`. or + `$client->setDefaultOption('headers', array('header_name' => 'value'))`. +- Removed `Guzzle\Http\ClientInterface::getDefaultHeaders(). Use `$client->getConfig()->getPath('request.options/headers')`. +- Removed `Guzzle\Http\ClientInterface::expandTemplate()`. This is an implementation detail. +- Removed `Guzzle\Http\ClientInterface::setRequestFactory()`. This is an implementation detail. +- Removed `Guzzle\Http\ClientInterface::getCurlMulti()`. This is a very specific implementation detail. +- Removed `Guzzle\Http\Message\RequestInterface::canCache`. Use the CachePlugin. +- Removed `Guzzle\Http\Message\RequestInterface::setIsRedirect`. Use the HistoryPlugin. +- Removed `Guzzle\Http\Message\RequestInterface::isRedirect`. Use the HistoryPlugin. + +### Cache plugin breaking changes + +- CacheKeyProviderInterface and DefaultCacheKeyProvider are no longer used. All of this logic is handled in a + CacheStorageInterface. These two objects and interface will be removed in a future version. +- Always setting X-cache headers on cached responses +- Default cache TTLs are now handled by the CacheStorageInterface of a CachePlugin +- `CacheStorageInterface::cache($key, Response $response, $ttl = null)` has changed to `cache(RequestInterface + $request, Response $response);` +- `CacheStorageInterface::fetch($key)` has changed to `fetch(RequestInterface $request);` +- `CacheStorageInterface::delete($key)` has changed to `delete(RequestInterface $request);` +- Added `CacheStorageInterface::purge($url)` +- `DefaultRevalidation::__construct(CacheKeyProviderInterface $cacheKey, CacheStorageInterface $cache, CachePlugin + $plugin)` has changed to `DefaultRevalidation::__construct(CacheStorageInterface $cache, + CanCacheStrategyInterface $canCache = null)` +- Added `RevalidationInterface::shouldRevalidate(RequestInterface $request, Response $response)` + +3.5 to 3.6 +---------- + +* Mixed casing of headers are now forced to be a single consistent casing across all values for that header. +* Messages internally use a HeaderCollection object to delegate handling case-insensitive header resolution +* Removed the whole changedHeader() function system of messages because all header changes now go through addHeader(). + For example, setHeader() first removes the header using unset on a HeaderCollection and then calls addHeader(). + Keeping the Host header and URL host in sync is now handled by overriding the addHeader method in Request. +* Specific header implementations can be created for complex headers. When a message creates a header, it uses a + HeaderFactory which can map specific headers to specific header classes. There is now a Link header and + CacheControl header implementation. +* Moved getLinks() from Response to just be used on a Link header object. + +If you previously relied on Guzzle\Http\Message\Header::raw(), then you will need to update your code to use the +HeaderInterface (e.g. toArray(), getAll(), etc.). + +### Interface changes + +* Removed from interface: Guzzle\Http\ClientInterface::setUriTemplate +* Removed from interface: Guzzle\Http\ClientInterface::setCurlMulti() +* Removed Guzzle\Http\Message\Request::receivedRequestHeader() and implemented this functionality in + Guzzle\Http\Curl\RequestMediator +* Removed the optional $asString parameter from MessageInterface::getHeader(). Just cast the header to a string. +* Removed the optional $tryChunkedTransfer option from Guzzle\Http\Message\EntityEnclosingRequestInterface +* Removed the $asObjects argument from Guzzle\Http\Message\MessageInterface::getHeaders() + +### Removed deprecated functions + +* Removed Guzzle\Parser\ParserRegister::get(). Use getParser() +* Removed Guzzle\Parser\ParserRegister::set(). Use registerParser(). + +### Deprecations + +* The ability to case-insensitively search for header values +* Guzzle\Http\Message\Header::hasExactHeader +* Guzzle\Http\Message\Header::raw. Use getAll() +* Deprecated cache control specific methods on Guzzle\Http\Message\AbstractMessage. Use the CacheControl header object + instead. + +### Other changes + +* All response header helper functions return a string rather than mixing Header objects and strings inconsistently +* Removed cURL blacklist support. This is no longer necessary now that Expect, Accept, etc. are managed by Guzzle + directly via interfaces +* Removed the injecting of a request object onto a response object. The methods to get and set a request still exist + but are a no-op until removed. +* Most classes that used to require a `Guzzle\Service\Command\CommandInterface` typehint now request a + `Guzzle\Service\Command\ArrayCommandInterface`. +* Added `Guzzle\Http\Message\RequestInterface::startResponse()` to the RequestInterface to handle injecting a response + on a request while the request is still being transferred +* `Guzzle\Service\Command\CommandInterface` now extends from ToArrayInterface and ArrayAccess + +3.3 to 3.4 +---------- + +Base URLs of a client now follow the rules of https://tools.ietf.org/html/rfc3986#section-5.2.2 when merging URLs. + +3.2 to 3.3 +---------- + +### Response::getEtag() quote stripping removed + +`Guzzle\Http\Message\Response::getEtag()` no longer strips quotes around the ETag response header + +### Removed `Guzzle\Http\Utils` + +The `Guzzle\Http\Utils` class was removed. This class was only used for testing. + +### Stream wrapper and type + +`Guzzle\Stream\Stream::getWrapper()` and `Guzzle\Stream\Stream::getStreamType()` are no longer converted to lowercase. + +### curl.emit_io became emit_io + +Emitting IO events from a RequestMediator is now a parameter that must be set in a request's curl options using the +'emit_io' key. This was previously set under a request's parameters using 'curl.emit_io' + +3.1 to 3.2 +---------- + +### CurlMulti is no longer reused globally + +Before 3.2, the same CurlMulti object was reused globally for each client. This can cause issue where plugins added +to a single client can pollute requests dispatched from other clients. + +If you still wish to reuse the same CurlMulti object with each client, then you can add a listener to the +ServiceBuilder's `service_builder.create_client` event to inject a custom CurlMulti object into each client as it is +created. + +```php +$multi = new Guzzle\Http\Curl\CurlMulti(); +$builder = Guzzle\Service\Builder\ServiceBuilder::factory('/path/to/config.json'); +$builder->addListener('service_builder.create_client', function ($event) use ($multi) { + $event['client']->setCurlMulti($multi); +} +}); +``` + +### No default path + +URLs no longer have a default path value of '/' if no path was specified. + +Before: + +```php +$request = $client->get('http://www.foo.com'); +echo $request->getUrl(); +// >> http://www.foo.com/ +``` + +After: + +```php +$request = $client->get('http://www.foo.com'); +echo $request->getUrl(); +// >> http://www.foo.com +``` + +### Less verbose BadResponseException + +The exception message for `Guzzle\Http\Exception\BadResponseException` no longer contains the full HTTP request and +response information. You can, however, get access to the request and response object by calling `getRequest()` or +`getResponse()` on the exception object. + +### Query parameter aggregation + +Multi-valued query parameters are no longer aggregated using a callback function. `Guzzle\Http\Query` now has a +setAggregator() method that accepts a `Guzzle\Http\QueryAggregator\QueryAggregatorInterface` object. This object is +responsible for handling the aggregation of multi-valued query string variables into a flattened hash. + +2.8 to 3.x +---------- + +### Guzzle\Service\Inspector + +Change `\Guzzle\Service\Inspector::fromConfig` to `\Guzzle\Common\Collection::fromConfig` + +**Before** + +```php +use Guzzle\Service\Inspector; + +class YourClient extends \Guzzle\Service\Client +{ + public static function factory($config = array()) + { + $default = array(); + $required = array('base_url', 'username', 'api_key'); + $config = Inspector::fromConfig($config, $default, $required); + + $client = new self( + $config->get('base_url'), + $config->get('username'), + $config->get('api_key') + ); + $client->setConfig($config); + + $client->setDescription(ServiceDescription::factory(__DIR__ . DIRECTORY_SEPARATOR . 'client.json')); + + return $client; + } +``` + +**After** + +```php +use Guzzle\Common\Collection; + +class YourClient extends \Guzzle\Service\Client +{ + public static function factory($config = array()) + { + $default = array(); + $required = array('base_url', 'username', 'api_key'); + $config = Collection::fromConfig($config, $default, $required); + + $client = new self( + $config->get('base_url'), + $config->get('username'), + $config->get('api_key') + ); + $client->setConfig($config); + + $client->setDescription(ServiceDescription::factory(__DIR__ . DIRECTORY_SEPARATOR . 'client.json')); + + return $client; + } +``` + +### Convert XML Service Descriptions to JSON + +**Before** + +```xml + + + + + + Get a list of groups + + + Uses a search query to get a list of groups + + + + Create a group + + + + + Delete a group by ID + + + + + + + Update a group + + + + + + +``` + +**After** + +```json +{ + "name": "Zendesk REST API v2", + "apiVersion": "2012-12-31", + "description":"Provides access to Zendesk views, groups, tickets, ticket fields, and users", + "operations": { + "list_groups": { + "httpMethod":"GET", + "uri": "groups.json", + "summary": "Get a list of groups" + }, + "search_groups":{ + "httpMethod":"GET", + "uri": "search.json?query=\"{query} type:group\"", + "summary": "Uses a search query to get a list of groups", + "parameters":{ + "query":{ + "location": "uri", + "description":"Zendesk Search Query", + "type": "string", + "required": true + } + } + }, + "create_group": { + "httpMethod":"POST", + "uri": "groups.json", + "summary": "Create a group", + "parameters":{ + "data": { + "type": "array", + "location": "body", + "description":"Group JSON", + "filters": "json_encode", + "required": true + }, + "Content-Type":{ + "type": "string", + "location":"header", + "static": "application/json" + } + } + }, + "delete_group": { + "httpMethod":"DELETE", + "uri": "groups/{id}.json", + "summary": "Delete a group", + "parameters":{ + "id":{ + "location": "uri", + "description":"Group to delete by ID", + "type": "integer", + "required": true + } + } + }, + "get_group": { + "httpMethod":"GET", + "uri": "groups/{id}.json", + "summary": "Get a ticket", + "parameters":{ + "id":{ + "location": "uri", + "description":"Group to get by ID", + "type": "integer", + "required": true + } + } + }, + "update_group": { + "httpMethod":"PUT", + "uri": "groups/{id}.json", + "summary": "Update a group", + "parameters":{ + "id": { + "location": "uri", + "description":"Group to update by ID", + "type": "integer", + "required": true + }, + "data": { + "type": "array", + "location": "body", + "description":"Group JSON", + "filters": "json_encode", + "required": true + }, + "Content-Type":{ + "type": "string", + "location":"header", + "static": "application/json" + } + } + } +} +``` + +### Guzzle\Service\Description\ServiceDescription + +Commands are now called Operations + +**Before** + +```php +use Guzzle\Service\Description\ServiceDescription; + +$sd = new ServiceDescription(); +$sd->getCommands(); // @returns ApiCommandInterface[] +$sd->hasCommand($name); +$sd->getCommand($name); // @returns ApiCommandInterface|null +$sd->addCommand($command); // @param ApiCommandInterface $command +``` + +**After** + +```php +use Guzzle\Service\Description\ServiceDescription; + +$sd = new ServiceDescription(); +$sd->getOperations(); // @returns OperationInterface[] +$sd->hasOperation($name); +$sd->getOperation($name); // @returns OperationInterface|null +$sd->addOperation($operation); // @param OperationInterface $operation +``` + +### Guzzle\Common\Inflection\Inflector + +Namespace is now `Guzzle\Inflection\Inflector` + +### Guzzle\Http\Plugin + +Namespace is now `Guzzle\Plugin`. Many other changes occur within this namespace and are detailed in their own sections below. + +### Guzzle\Http\Plugin\LogPlugin and Guzzle\Common\Log + +Now `Guzzle\Plugin\Log\LogPlugin` and `Guzzle\Log` respectively. + +**Before** + +```php +use Guzzle\Common\Log\ClosureLogAdapter; +use Guzzle\Http\Plugin\LogPlugin; + +/** @var \Guzzle\Http\Client */ +$client; + +// $verbosity is an integer indicating desired message verbosity level +$client->addSubscriber(new LogPlugin(new ClosureLogAdapter(function($m) { echo $m; }, $verbosity = LogPlugin::LOG_VERBOSE); +``` + +**After** + +```php +use Guzzle\Log\ClosureLogAdapter; +use Guzzle\Log\MessageFormatter; +use Guzzle\Plugin\Log\LogPlugin; + +/** @var \Guzzle\Http\Client */ +$client; + +// $format is a string indicating desired message format -- @see MessageFormatter +$client->addSubscriber(new LogPlugin(new ClosureLogAdapter(function($m) { echo $m; }, $format = MessageFormatter::DEBUG_FORMAT); +``` + +### Guzzle\Http\Plugin\CurlAuthPlugin + +Now `Guzzle\Plugin\CurlAuth\CurlAuthPlugin`. + +### Guzzle\Http\Plugin\ExponentialBackoffPlugin + +Now `Guzzle\Plugin\Backoff\BackoffPlugin`, and other changes. + +**Before** + +```php +use Guzzle\Http\Plugin\ExponentialBackoffPlugin; + +$backoffPlugin = new ExponentialBackoffPlugin($maxRetries, array_merge( + ExponentialBackoffPlugin::getDefaultFailureCodes(), array(429) + )); + +$client->addSubscriber($backoffPlugin); +``` + +**After** + +```php +use Guzzle\Plugin\Backoff\BackoffPlugin; +use Guzzle\Plugin\Backoff\HttpBackoffStrategy; + +// Use convenient factory method instead -- see implementation for ideas of what +// you can do with chaining backoff strategies +$backoffPlugin = BackoffPlugin::getExponentialBackoff($maxRetries, array_merge( + HttpBackoffStrategy::getDefaultFailureCodes(), array(429) + )); +$client->addSubscriber($backoffPlugin); +``` + +### Known Issues + +#### [BUG] Accept-Encoding header behavior changed unintentionally. + +(See #217) (Fixed in 09daeb8c666fb44499a0646d655a8ae36456575e) + +In version 2.8 setting the `Accept-Encoding` header would set the CURLOPT_ENCODING option, which permitted cURL to +properly handle gzip/deflate compressed responses from the server. In versions affected by this bug this does not happen. +See issue #217 for a workaround, or use a version containing the fix. diff --git a/lib/guzzlehttp/guzzle/composer.json b/lib/guzzlehttp/guzzle/composer.json new file mode 100644 index 00000000..5d2025b9 --- /dev/null +++ b/lib/guzzlehttp/guzzle/composer.json @@ -0,0 +1,98 @@ +{ + "name": "guzzlehttp/guzzle", + "description": "Guzzle is a PHP HTTP client library", + "keywords": [ + "framework", + "http", + "rest", + "web service", + "curl", + "client", + "HTTP client", + "PSR-7", + "PSR-18" + ], + "license": "MIT", + "authors": [ + { + "name": "Graham Campbell", + "email": "hello@gjcampbell.co.uk", + "homepage": "https://github.com/GrahamCampbell" + }, + { + "name": "Michael Dowling", + "email": "mtdowling@gmail.com", + "homepage": "https://github.com/mtdowling" + }, + { + "name": "Jeremy Lindblom", + "email": "jeremeamia@gmail.com", + "homepage": "https://github.com/jeremeamia" + }, + { + "name": "George Mponos", + "email": "gmponos@gmail.com", + "homepage": "https://github.com/gmponos" + }, + { + "name": "Tobias Nyholm", + "email": "tobias.nyholm@gmail.com", + "homepage": "https://github.com/Nyholm" + }, + { + "name": "Márk Sági-Kazár", + "email": "mark.sagikazar@gmail.com", + "homepage": "https://github.com/sagikazarmark" + }, + { + "name": "Tobias Schultze", + "email": "webmaster@tubo-world.de", + "homepage": "https://github.com/Tobion" + } + ], + "require": { + "php": "^7.2.5 || ^8.0", + "ext-json": "*", + "guzzlehttp/promises": "^1.5", + "guzzlehttp/psr7": "^1.8.3 || ^2.1", + "psr/http-client": "^1.0", + "symfony/deprecation-contracts": "^2.2" + }, + "provide": { + "psr/http-client-implementation": "1.0" + }, + "require-dev": { + "ext-curl": "*", + "bamarni/composer-bin-plugin": "^1.4.1", + "php-http/client-integration-tests": "^3.0", + "phpunit/phpunit": "^8.5.5 || ^9.3.5", + "psr/log": "^1.1 || ^2.0 || ^3.0" + }, + "suggest": { + "ext-curl": "Required for CURL handler support", + "ext-intl": "Required for Internationalized Domain Name (IDN) support", + "psr/log": "Required for using the Log middleware" + }, + "config": { + "preferred-install": "dist", + "sort-packages": true + }, + "extra": { + "branch-alias": { + "dev-master": "7.4-dev" + } + }, + "autoload": { + "psr-4": { + "GuzzleHttp\\": "src/" + }, + "files": [ + "src/functions_include.php" + ] + }, + "autoload-dev": { + "psr-4": { + "GuzzleHttp\\Tests\\": "tests/" + } + } +} diff --git a/lib/guzzlehttp/guzzle/src/BodySummarizer.php b/lib/guzzlehttp/guzzle/src/BodySummarizer.php new file mode 100644 index 00000000..6eca94ef --- /dev/null +++ b/lib/guzzlehttp/guzzle/src/BodySummarizer.php @@ -0,0 +1,28 @@ +truncateAt = $truncateAt; + } + + /** + * Returns a summarized message body. + */ + public function summarize(MessageInterface $message): ?string + { + return $this->truncateAt === null + ? \GuzzleHttp\Psr7\Message::bodySummary($message) + : \GuzzleHttp\Psr7\Message::bodySummary($message, $this->truncateAt); + } +} diff --git a/lib/guzzlehttp/guzzle/src/BodySummarizerInterface.php b/lib/guzzlehttp/guzzle/src/BodySummarizerInterface.php new file mode 100644 index 00000000..3e02e036 --- /dev/null +++ b/lib/guzzlehttp/guzzle/src/BodySummarizerInterface.php @@ -0,0 +1,13 @@ + 'http://www.foo.com/1.0/', + * 'timeout' => 0, + * 'allow_redirects' => false, + * 'proxy' => '192.168.16.1:10' + * ]); + * + * Client configuration settings include the following options: + * + * - handler: (callable) Function that transfers HTTP requests over the + * wire. The function is called with a Psr7\Http\Message\RequestInterface + * and array of transfer options, and must return a + * GuzzleHttp\Promise\PromiseInterface that is fulfilled with a + * Psr7\Http\Message\ResponseInterface on success. + * If no handler is provided, a default handler will be created + * that enables all of the request options below by attaching all of the + * default middleware to the handler. + * - base_uri: (string|UriInterface) Base URI of the client that is merged + * into relative URIs. Can be a string or instance of UriInterface. + * - **: any request option + * + * @param array $config Client configuration settings. + * + * @see \GuzzleHttp\RequestOptions for a list of available request options. + */ + public function __construct(array $config = []) + { + if (!isset($config['handler'])) { + $config['handler'] = HandlerStack::create(); + } elseif (!\is_callable($config['handler'])) { + throw new InvalidArgumentException('handler must be a callable'); + } + + // Convert the base_uri to a UriInterface + if (isset($config['base_uri'])) { + $config['base_uri'] = Psr7\Utils::uriFor($config['base_uri']); + } + + $this->configureDefaults($config); + } + + /** + * @param string $method + * @param array $args + * + * @return PromiseInterface|ResponseInterface + * + * @deprecated Client::__call will be removed in guzzlehttp/guzzle:8.0. + */ + public function __call($method, $args) + { + if (\count($args) < 1) { + throw new InvalidArgumentException('Magic request methods require a URI and optional options array'); + } + + $uri = $args[0]; + $opts = $args[1] ?? []; + + return \substr($method, -5) === 'Async' + ? $this->requestAsync(\substr($method, 0, -5), $uri, $opts) + : $this->request($method, $uri, $opts); + } + + /** + * Asynchronously send an HTTP request. + * + * @param array $options Request options to apply to the given + * request and to the transfer. See \GuzzleHttp\RequestOptions. + */ + public function sendAsync(RequestInterface $request, array $options = []): PromiseInterface + { + // Merge the base URI into the request URI if needed. + $options = $this->prepareDefaults($options); + + return $this->transfer( + $request->withUri($this->buildUri($request->getUri(), $options), $request->hasHeader('Host')), + $options + ); + } + + /** + * Send an HTTP request. + * + * @param array $options Request options to apply to the given + * request and to the transfer. See \GuzzleHttp\RequestOptions. + * + * @throws GuzzleException + */ + public function send(RequestInterface $request, array $options = []): ResponseInterface + { + $options[RequestOptions::SYNCHRONOUS] = true; + return $this->sendAsync($request, $options)->wait(); + } + + /** + * The HttpClient PSR (PSR-18) specify this method. + * + * @inheritDoc + */ + public function sendRequest(RequestInterface $request): ResponseInterface + { + $options[RequestOptions::SYNCHRONOUS] = true; + $options[RequestOptions::ALLOW_REDIRECTS] = false; + $options[RequestOptions::HTTP_ERRORS] = false; + + return $this->sendAsync($request, $options)->wait(); + } + + /** + * Create and send an asynchronous HTTP request. + * + * Use an absolute path to override the base path of the client, or a + * relative path to append to the base path of the client. The URL can + * contain the query string as well. Use an array to provide a URL + * template and additional variables to use in the URL template expansion. + * + * @param string $method HTTP method + * @param string|UriInterface $uri URI object or string. + * @param array $options Request options to apply. See \GuzzleHttp\RequestOptions. + */ + public function requestAsync(string $method, $uri = '', array $options = []): PromiseInterface + { + $options = $this->prepareDefaults($options); + // Remove request modifying parameter because it can be done up-front. + $headers = $options['headers'] ?? []; + $body = $options['body'] ?? null; + $version = $options['version'] ?? '1.1'; + // Merge the URI into the base URI. + $uri = $this->buildUri(Psr7\Utils::uriFor($uri), $options); + if (\is_array($body)) { + throw $this->invalidBody(); + } + $request = new Psr7\Request($method, $uri, $headers, $body, $version); + // Remove the option so that they are not doubly-applied. + unset($options['headers'], $options['body'], $options['version']); + + return $this->transfer($request, $options); + } + + /** + * Create and send an HTTP request. + * + * Use an absolute path to override the base path of the client, or a + * relative path to append to the base path of the client. The URL can + * contain the query string as well. + * + * @param string $method HTTP method. + * @param string|UriInterface $uri URI object or string. + * @param array $options Request options to apply. See \GuzzleHttp\RequestOptions. + * + * @throws GuzzleException + */ + public function request(string $method, $uri = '', array $options = []): ResponseInterface + { + $options[RequestOptions::SYNCHRONOUS] = true; + return $this->requestAsync($method, $uri, $options)->wait(); + } + + /** + * Get a client configuration option. + * + * These options include default request options of the client, a "handler" + * (if utilized by the concrete client), and a "base_uri" if utilized by + * the concrete client. + * + * @param string|null $option The config option to retrieve. + * + * @return mixed + * + * @deprecated Client::getConfig will be removed in guzzlehttp/guzzle:8.0. + */ + public function getConfig(?string $option = null) + { + return $option === null + ? $this->config + : ($this->config[$option] ?? null); + } + + private function buildUri(UriInterface $uri, array $config): UriInterface + { + if (isset($config['base_uri'])) { + $uri = Psr7\UriResolver::resolve(Psr7\Utils::uriFor($config['base_uri']), $uri); + } + + if (isset($config['idn_conversion']) && ($config['idn_conversion'] !== false)) { + $idnOptions = ($config['idn_conversion'] === true) ? \IDNA_DEFAULT : $config['idn_conversion']; + $uri = Utils::idnUriConvert($uri, $idnOptions); + } + + return $uri->getScheme() === '' && $uri->getHost() !== '' ? $uri->withScheme('http') : $uri; + } + + /** + * Configures the default options for a client. + */ + private function configureDefaults(array $config): void + { + $defaults = [ + 'allow_redirects' => RedirectMiddleware::$defaultSettings, + 'http_errors' => true, + 'decode_content' => true, + 'verify' => true, + 'cookies' => false, + 'idn_conversion' => false, + ]; + + // Use the standard Linux HTTP_PROXY and HTTPS_PROXY if set. + + // We can only trust the HTTP_PROXY environment variable in a CLI + // process due to the fact that PHP has no reliable mechanism to + // get environment variables that start with "HTTP_". + if (\PHP_SAPI === 'cli' && ($proxy = Utils::getenv('HTTP_PROXY'))) { + $defaults['proxy']['http'] = $proxy; + } + + if ($proxy = Utils::getenv('HTTPS_PROXY')) { + $defaults['proxy']['https'] = $proxy; + } + + if ($noProxy = Utils::getenv('NO_PROXY')) { + $cleanedNoProxy = \str_replace(' ', '', $noProxy); + $defaults['proxy']['no'] = \explode(',', $cleanedNoProxy); + } + + $this->config = $config + $defaults; + + if (!empty($config['cookies']) && $config['cookies'] === true) { + $this->config['cookies'] = new CookieJar(); + } + + // Add the default user-agent header. + if (!isset($this->config['headers'])) { + $this->config['headers'] = ['User-Agent' => Utils::defaultUserAgent()]; + } else { + // Add the User-Agent header if one was not already set. + foreach (\array_keys($this->config['headers']) as $name) { + if (\strtolower($name) === 'user-agent') { + return; + } + } + $this->config['headers']['User-Agent'] = Utils::defaultUserAgent(); + } + } + + /** + * Merges default options into the array. + * + * @param array $options Options to modify by reference + */ + private function prepareDefaults(array $options): array + { + $defaults = $this->config; + + if (!empty($defaults['headers'])) { + // Default headers are only added if they are not present. + $defaults['_conditional'] = $defaults['headers']; + unset($defaults['headers']); + } + + // Special handling for headers is required as they are added as + // conditional headers and as headers passed to a request ctor. + if (\array_key_exists('headers', $options)) { + // Allows default headers to be unset. + if ($options['headers'] === null) { + $defaults['_conditional'] = []; + unset($options['headers']); + } elseif (!\is_array($options['headers'])) { + throw new InvalidArgumentException('headers must be an array'); + } + } + + // Shallow merge defaults underneath options. + $result = $options + $defaults; + + // Remove null values. + foreach ($result as $k => $v) { + if ($v === null) { + unset($result[$k]); + } + } + + return $result; + } + + /** + * Transfers the given request and applies request options. + * + * The URI of the request is not modified and the request options are used + * as-is without merging in default options. + * + * @param array $options See \GuzzleHttp\RequestOptions. + */ + private function transfer(RequestInterface $request, array $options): PromiseInterface + { + $request = $this->applyOptions($request, $options); + /** @var HandlerStack $handler */ + $handler = $options['handler']; + + try { + return P\Create::promiseFor($handler($request, $options)); + } catch (\Exception $e) { + return P\Create::rejectionFor($e); + } + } + + /** + * Applies the array of request options to a request. + */ + private function applyOptions(RequestInterface $request, array &$options): RequestInterface + { + $modify = [ + 'set_headers' => [], + ]; + + if (isset($options['headers'])) { + if (array_keys($options['headers']) === range(0, count($options['headers']) - 1)) { + throw new InvalidArgumentException('The headers array must have header name as keys.'); + } + $modify['set_headers'] = $options['headers']; + unset($options['headers']); + } + + if (isset($options['form_params'])) { + if (isset($options['multipart'])) { + throw new InvalidArgumentException('You cannot use ' + . 'form_params and multipart at the same time. Use the ' + . 'form_params option if you want to send application/' + . 'x-www-form-urlencoded requests, and the multipart ' + . 'option to send multipart/form-data requests.'); + } + $options['body'] = \http_build_query($options['form_params'], '', '&'); + unset($options['form_params']); + // Ensure that we don't have the header in different case and set the new value. + $options['_conditional'] = Psr7\Utils::caselessRemove(['Content-Type'], $options['_conditional']); + $options['_conditional']['Content-Type'] = 'application/x-www-form-urlencoded'; + } + + if (isset($options['multipart'])) { + $options['body'] = new Psr7\MultipartStream($options['multipart']); + unset($options['multipart']); + } + + if (isset($options['json'])) { + $options['body'] = Utils::jsonEncode($options['json']); + unset($options['json']); + // Ensure that we don't have the header in different case and set the new value. + $options['_conditional'] = Psr7\Utils::caselessRemove(['Content-Type'], $options['_conditional']); + $options['_conditional']['Content-Type'] = 'application/json'; + } + + if (!empty($options['decode_content']) + && $options['decode_content'] !== true + ) { + // Ensure that we don't have the header in different case and set the new value. + $options['_conditional'] = Psr7\Utils::caselessRemove(['Accept-Encoding'], $options['_conditional']); + $modify['set_headers']['Accept-Encoding'] = $options['decode_content']; + } + + if (isset($options['body'])) { + if (\is_array($options['body'])) { + throw $this->invalidBody(); + } + $modify['body'] = Psr7\Utils::streamFor($options['body']); + unset($options['body']); + } + + if (!empty($options['auth']) && \is_array($options['auth'])) { + $value = $options['auth']; + $type = isset($value[2]) ? \strtolower($value[2]) : 'basic'; + switch ($type) { + case 'basic': + // Ensure that we don't have the header in different case and set the new value. + $modify['set_headers'] = Psr7\Utils::caselessRemove(['Authorization'], $modify['set_headers']); + $modify['set_headers']['Authorization'] = 'Basic ' + . \base64_encode("$value[0]:$value[1]"); + break; + case 'digest': + // @todo: Do not rely on curl + $options['curl'][\CURLOPT_HTTPAUTH] = \CURLAUTH_DIGEST; + $options['curl'][\CURLOPT_USERPWD] = "$value[0]:$value[1]"; + break; + case 'ntlm': + $options['curl'][\CURLOPT_HTTPAUTH] = \CURLAUTH_NTLM; + $options['curl'][\CURLOPT_USERPWD] = "$value[0]:$value[1]"; + break; + } + } + + if (isset($options['query'])) { + $value = $options['query']; + if (\is_array($value)) { + $value = \http_build_query($value, '', '&', \PHP_QUERY_RFC3986); + } + if (!\is_string($value)) { + throw new InvalidArgumentException('query must be a string or array'); + } + $modify['query'] = $value; + unset($options['query']); + } + + // Ensure that sink is not an invalid value. + if (isset($options['sink'])) { + // TODO: Add more sink validation? + if (\is_bool($options['sink'])) { + throw new InvalidArgumentException('sink must not be a boolean'); + } + } + + $request = Psr7\Utils::modifyRequest($request, $modify); + if ($request->getBody() instanceof Psr7\MultipartStream) { + // Use a multipart/form-data POST if a Content-Type is not set. + // Ensure that we don't have the header in different case and set the new value. + $options['_conditional'] = Psr7\Utils::caselessRemove(['Content-Type'], $options['_conditional']); + $options['_conditional']['Content-Type'] = 'multipart/form-data; boundary=' + . $request->getBody()->getBoundary(); + } + + // Merge in conditional headers if they are not present. + if (isset($options['_conditional'])) { + // Build up the changes so it's in a single clone of the message. + $modify = []; + foreach ($options['_conditional'] as $k => $v) { + if (!$request->hasHeader($k)) { + $modify['set_headers'][$k] = $v; + } + } + $request = Psr7\Utils::modifyRequest($request, $modify); + // Don't pass this internal value along to middleware/handlers. + unset($options['_conditional']); + } + + return $request; + } + + /** + * Return an InvalidArgumentException with pre-set message. + */ + private function invalidBody(): InvalidArgumentException + { + return new InvalidArgumentException('Passing in the "body" request ' + . 'option as an array to send a request is not supported. ' + . 'Please use the "form_params" request option to send a ' + . 'application/x-www-form-urlencoded request, or the "multipart" ' + . 'request option to send a multipart/form-data request.'); + } +} diff --git a/lib/guzzlehttp/guzzle/src/ClientInterface.php b/lib/guzzlehttp/guzzle/src/ClientInterface.php new file mode 100644 index 00000000..6aaee61a --- /dev/null +++ b/lib/guzzlehttp/guzzle/src/ClientInterface.php @@ -0,0 +1,84 @@ +request('GET', $uri, $options); + } + + /** + * Create and send an HTTP HEAD request. + * + * Use an absolute path to override the base path of the client, or a + * relative path to append to the base path of the client. The URL can + * contain the query string as well. + * + * @param string|UriInterface $uri URI object or string. + * @param array $options Request options to apply. + * + * @throws GuzzleException + */ + public function head($uri, array $options = []): ResponseInterface + { + return $this->request('HEAD', $uri, $options); + } + + /** + * Create and send an HTTP PUT request. + * + * Use an absolute path to override the base path of the client, or a + * relative path to append to the base path of the client. The URL can + * contain the query string as well. + * + * @param string|UriInterface $uri URI object or string. + * @param array $options Request options to apply. + * + * @throws GuzzleException + */ + public function put($uri, array $options = []): ResponseInterface + { + return $this->request('PUT', $uri, $options); + } + + /** + * Create and send an HTTP POST request. + * + * Use an absolute path to override the base path of the client, or a + * relative path to append to the base path of the client. The URL can + * contain the query string as well. + * + * @param string|UriInterface $uri URI object or string. + * @param array $options Request options to apply. + * + * @throws GuzzleException + */ + public function post($uri, array $options = []): ResponseInterface + { + return $this->request('POST', $uri, $options); + } + + /** + * Create and send an HTTP PATCH request. + * + * Use an absolute path to override the base path of the client, or a + * relative path to append to the base path of the client. The URL can + * contain the query string as well. + * + * @param string|UriInterface $uri URI object or string. + * @param array $options Request options to apply. + * + * @throws GuzzleException + */ + public function patch($uri, array $options = []): ResponseInterface + { + return $this->request('PATCH', $uri, $options); + } + + /** + * Create and send an HTTP DELETE request. + * + * Use an absolute path to override the base path of the client, or a + * relative path to append to the base path of the client. The URL can + * contain the query string as well. + * + * @param string|UriInterface $uri URI object or string. + * @param array $options Request options to apply. + * + * @throws GuzzleException + */ + public function delete($uri, array $options = []): ResponseInterface + { + return $this->request('DELETE', $uri, $options); + } + + /** + * Create and send an asynchronous HTTP request. + * + * Use an absolute path to override the base path of the client, or a + * relative path to append to the base path of the client. The URL can + * contain the query string as well. Use an array to provide a URL + * template and additional variables to use in the URL template expansion. + * + * @param string $method HTTP method + * @param string|UriInterface $uri URI object or string. + * @param array $options Request options to apply. + */ + abstract public function requestAsync(string $method, $uri, array $options = []): PromiseInterface; + + /** + * Create and send an asynchronous HTTP GET request. + * + * Use an absolute path to override the base path of the client, or a + * relative path to append to the base path of the client. The URL can + * contain the query string as well. Use an array to provide a URL + * template and additional variables to use in the URL template expansion. + * + * @param string|UriInterface $uri URI object or string. + * @param array $options Request options to apply. + */ + public function getAsync($uri, array $options = []): PromiseInterface + { + return $this->requestAsync('GET', $uri, $options); + } + + /** + * Create and send an asynchronous HTTP HEAD request. + * + * Use an absolute path to override the base path of the client, or a + * relative path to append to the base path of the client. The URL can + * contain the query string as well. Use an array to provide a URL + * template and additional variables to use in the URL template expansion. + * + * @param string|UriInterface $uri URI object or string. + * @param array $options Request options to apply. + */ + public function headAsync($uri, array $options = []): PromiseInterface + { + return $this->requestAsync('HEAD', $uri, $options); + } + + /** + * Create and send an asynchronous HTTP PUT request. + * + * Use an absolute path to override the base path of the client, or a + * relative path to append to the base path of the client. The URL can + * contain the query string as well. Use an array to provide a URL + * template and additional variables to use in the URL template expansion. + * + * @param string|UriInterface $uri URI object or string. + * @param array $options Request options to apply. + */ + public function putAsync($uri, array $options = []): PromiseInterface + { + return $this->requestAsync('PUT', $uri, $options); + } + + /** + * Create and send an asynchronous HTTP POST request. + * + * Use an absolute path to override the base path of the client, or a + * relative path to append to the base path of the client. The URL can + * contain the query string as well. Use an array to provide a URL + * template and additional variables to use in the URL template expansion. + * + * @param string|UriInterface $uri URI object or string. + * @param array $options Request options to apply. + */ + public function postAsync($uri, array $options = []): PromiseInterface + { + return $this->requestAsync('POST', $uri, $options); + } + + /** + * Create and send an asynchronous HTTP PATCH request. + * + * Use an absolute path to override the base path of the client, or a + * relative path to append to the base path of the client. The URL can + * contain the query string as well. Use an array to provide a URL + * template and additional variables to use in the URL template expansion. + * + * @param string|UriInterface $uri URI object or string. + * @param array $options Request options to apply. + */ + public function patchAsync($uri, array $options = []): PromiseInterface + { + return $this->requestAsync('PATCH', $uri, $options); + } + + /** + * Create and send an asynchronous HTTP DELETE request. + * + * Use an absolute path to override the base path of the client, or a + * relative path to append to the base path of the client. The URL can + * contain the query string as well. Use an array to provide a URL + * template and additional variables to use in the URL template expansion. + * + * @param string|UriInterface $uri URI object or string. + * @param array $options Request options to apply. + */ + public function deleteAsync($uri, array $options = []): PromiseInterface + { + return $this->requestAsync('DELETE', $uri, $options); + } +} diff --git a/lib/guzzlehttp/guzzle/src/Cookie/CookieJar.php b/lib/guzzlehttp/guzzle/src/Cookie/CookieJar.php new file mode 100644 index 00000000..d6757c65 --- /dev/null +++ b/lib/guzzlehttp/guzzle/src/Cookie/CookieJar.php @@ -0,0 +1,313 @@ +strictMode = $strictMode; + + foreach ($cookieArray as $cookie) { + if (!($cookie instanceof SetCookie)) { + $cookie = new SetCookie($cookie); + } + $this->setCookie($cookie); + } + } + + /** + * Create a new Cookie jar from an associative array and domain. + * + * @param array $cookies Cookies to create the jar from + * @param string $domain Domain to set the cookies to + */ + public static function fromArray(array $cookies, string $domain): self + { + $cookieJar = new self(); + foreach ($cookies as $name => $value) { + $cookieJar->setCookie(new SetCookie([ + 'Domain' => $domain, + 'Name' => $name, + 'Value' => $value, + 'Discard' => true + ])); + } + + return $cookieJar; + } + + /** + * Evaluate if this cookie should be persisted to storage + * that survives between requests. + * + * @param SetCookie $cookie Being evaluated. + * @param bool $allowSessionCookies If we should persist session cookies + */ + public static function shouldPersist(SetCookie $cookie, bool $allowSessionCookies = false): bool + { + if ($cookie->getExpires() || $allowSessionCookies) { + if (!$cookie->getDiscard()) { + return true; + } + } + + return false; + } + + /** + * Finds and returns the cookie based on the name + * + * @param string $name cookie name to search for + * + * @return SetCookie|null cookie that was found or null if not found + */ + public function getCookieByName(string $name): ?SetCookie + { + foreach ($this->cookies as $cookie) { + if ($cookie->getName() !== null && \strcasecmp($cookie->getName(), $name) === 0) { + return $cookie; + } + } + + return null; + } + + /** + * @inheritDoc + */ + public function toArray(): array + { + return \array_map(static function (SetCookie $cookie): array { + return $cookie->toArray(); + }, $this->getIterator()->getArrayCopy()); + } + + /** + * @inheritDoc + */ + public function clear(?string $domain = null, ?string $path = null, ?string $name = null): void + { + if (!$domain) { + $this->cookies = []; + return; + } elseif (!$path) { + $this->cookies = \array_filter( + $this->cookies, + static function (SetCookie $cookie) use ($domain): bool { + return !$cookie->matchesDomain($domain); + } + ); + } elseif (!$name) { + $this->cookies = \array_filter( + $this->cookies, + static function (SetCookie $cookie) use ($path, $domain): bool { + return !($cookie->matchesPath($path) && + $cookie->matchesDomain($domain)); + } + ); + } else { + $this->cookies = \array_filter( + $this->cookies, + static function (SetCookie $cookie) use ($path, $domain, $name) { + return !($cookie->getName() == $name && + $cookie->matchesPath($path) && + $cookie->matchesDomain($domain)); + } + ); + } + } + + /** + * @inheritDoc + */ + public function clearSessionCookies(): void + { + $this->cookies = \array_filter( + $this->cookies, + static function (SetCookie $cookie): bool { + return !$cookie->getDiscard() && $cookie->getExpires(); + } + ); + } + + /** + * @inheritDoc + */ + public function setCookie(SetCookie $cookie): bool + { + // If the name string is empty (but not 0), ignore the set-cookie + // string entirely. + $name = $cookie->getName(); + if (!$name && $name !== '0') { + return false; + } + + // Only allow cookies with set and valid domain, name, value + $result = $cookie->validate(); + if ($result !== true) { + if ($this->strictMode) { + throw new \RuntimeException('Invalid cookie: ' . $result); + } + $this->removeCookieIfEmpty($cookie); + return false; + } + + // Resolve conflicts with previously set cookies + foreach ($this->cookies as $i => $c) { + + // Two cookies are identical, when their path, and domain are + // identical. + if ($c->getPath() != $cookie->getPath() || + $c->getDomain() != $cookie->getDomain() || + $c->getName() != $cookie->getName() + ) { + continue; + } + + // The previously set cookie is a discard cookie and this one is + // not so allow the new cookie to be set + if (!$cookie->getDiscard() && $c->getDiscard()) { + unset($this->cookies[$i]); + continue; + } + + // If the new cookie's expiration is further into the future, then + // replace the old cookie + if ($cookie->getExpires() > $c->getExpires()) { + unset($this->cookies[$i]); + continue; + } + + // If the value has changed, we better change it + if ($cookie->getValue() !== $c->getValue()) { + unset($this->cookies[$i]); + continue; + } + + // The cookie exists, so no need to continue + return false; + } + + $this->cookies[] = $cookie; + + return true; + } + + public function count(): int + { + return \count($this->cookies); + } + + /** + * @return \ArrayIterator + */ + public function getIterator(): \ArrayIterator + { + return new \ArrayIterator(\array_values($this->cookies)); + } + + public function extractCookies(RequestInterface $request, ResponseInterface $response): void + { + if ($cookieHeader = $response->getHeader('Set-Cookie')) { + foreach ($cookieHeader as $cookie) { + $sc = SetCookie::fromString($cookie); + if (!$sc->getDomain()) { + $sc->setDomain($request->getUri()->getHost()); + } + if (0 !== \strpos($sc->getPath(), '/')) { + $sc->setPath($this->getCookiePathFromRequest($request)); + } + $this->setCookie($sc); + } + } + } + + /** + * Computes cookie path following RFC 6265 section 5.1.4 + * + * @link https://tools.ietf.org/html/rfc6265#section-5.1.4 + */ + private function getCookiePathFromRequest(RequestInterface $request): string + { + $uriPath = $request->getUri()->getPath(); + if ('' === $uriPath) { + return '/'; + } + if (0 !== \strpos($uriPath, '/')) { + return '/'; + } + if ('/' === $uriPath) { + return '/'; + } + $lastSlashPos = \strrpos($uriPath, '/'); + if (0 === $lastSlashPos || false === $lastSlashPos) { + return '/'; + } + + return \substr($uriPath, 0, $lastSlashPos); + } + + public function withCookieHeader(RequestInterface $request): RequestInterface + { + $values = []; + $uri = $request->getUri(); + $scheme = $uri->getScheme(); + $host = $uri->getHost(); + $path = $uri->getPath() ?: '/'; + + foreach ($this->cookies as $cookie) { + if ($cookie->matchesPath($path) && + $cookie->matchesDomain($host) && + !$cookie->isExpired() && + (!$cookie->getSecure() || $scheme === 'https') + ) { + $values[] = $cookie->getName() . '=' + . $cookie->getValue(); + } + } + + return $values + ? $request->withHeader('Cookie', \implode('; ', $values)) + : $request; + } + + /** + * If a cookie already exists and the server asks to set it again with a + * null value, the cookie must be deleted. + */ + private function removeCookieIfEmpty(SetCookie $cookie): void + { + $cookieValue = $cookie->getValue(); + if ($cookieValue === null || $cookieValue === '') { + $this->clear( + $cookie->getDomain(), + $cookie->getPath(), + $cookie->getName() + ); + } + } +} diff --git a/lib/guzzlehttp/guzzle/src/Cookie/CookieJarInterface.php b/lib/guzzlehttp/guzzle/src/Cookie/CookieJarInterface.php new file mode 100644 index 00000000..7df374b5 --- /dev/null +++ b/lib/guzzlehttp/guzzle/src/Cookie/CookieJarInterface.php @@ -0,0 +1,79 @@ + + */ +interface CookieJarInterface extends \Countable, \IteratorAggregate +{ + /** + * Create a request with added cookie headers. + * + * If no matching cookies are found in the cookie jar, then no Cookie + * header is added to the request and the same request is returned. + * + * @param RequestInterface $request Request object to modify. + * + * @return RequestInterface returns the modified request. + */ + public function withCookieHeader(RequestInterface $request): RequestInterface; + + /** + * Extract cookies from an HTTP response and store them in the CookieJar. + * + * @param RequestInterface $request Request that was sent + * @param ResponseInterface $response Response that was received + */ + public function extractCookies(RequestInterface $request, ResponseInterface $response): void; + + /** + * Sets a cookie in the cookie jar. + * + * @param SetCookie $cookie Cookie to set. + * + * @return bool Returns true on success or false on failure + */ + public function setCookie(SetCookie $cookie): bool; + + /** + * Remove cookies currently held in the cookie jar. + * + * Invoking this method without arguments will empty the whole cookie jar. + * If given a $domain argument only cookies belonging to that domain will + * be removed. If given a $domain and $path argument, cookies belonging to + * the specified path within that domain are removed. If given all three + * arguments, then the cookie with the specified name, path and domain is + * removed. + * + * @param string|null $domain Clears cookies matching a domain + * @param string|null $path Clears cookies matching a domain and path + * @param string|null $name Clears cookies matching a domain, path, and name + */ + public function clear(?string $domain = null, ?string $path = null, ?string $name = null): void; + + /** + * Discard all sessions cookies. + * + * Removes cookies that don't have an expire field or a have a discard + * field set to true. To be called when the user agent shuts down according + * to RFC 2965. + */ + public function clearSessionCookies(): void; + + /** + * Converts the cookie jar to an array. + */ + public function toArray(): array; +} diff --git a/lib/guzzlehttp/guzzle/src/Cookie/FileCookieJar.php b/lib/guzzlehttp/guzzle/src/Cookie/FileCookieJar.php new file mode 100644 index 00000000..290236d5 --- /dev/null +++ b/lib/guzzlehttp/guzzle/src/Cookie/FileCookieJar.php @@ -0,0 +1,101 @@ +filename = $cookieFile; + $this->storeSessionCookies = $storeSessionCookies; + + if (\file_exists($cookieFile)) { + $this->load($cookieFile); + } + } + + /** + * Saves the file when shutting down + */ + public function __destruct() + { + $this->save($this->filename); + } + + /** + * Saves the cookies to a file. + * + * @param string $filename File to save + * + * @throws \RuntimeException if the file cannot be found or created + */ + public function save(string $filename): void + { + $json = []; + /** @var SetCookie $cookie */ + foreach ($this as $cookie) { + if (CookieJar::shouldPersist($cookie, $this->storeSessionCookies)) { + $json[] = $cookie->toArray(); + } + } + + $jsonStr = Utils::jsonEncode($json); + if (false === \file_put_contents($filename, $jsonStr, \LOCK_EX)) { + throw new \RuntimeException("Unable to save file {$filename}"); + } + } + + /** + * Load cookies from a JSON formatted file. + * + * Old cookies are kept unless overwritten by newly loaded ones. + * + * @param string $filename Cookie file to load. + * + * @throws \RuntimeException if the file cannot be loaded. + */ + public function load(string $filename): void + { + $json = \file_get_contents($filename); + if (false === $json) { + throw new \RuntimeException("Unable to load file {$filename}"); + } + if ($json === '') { + return; + } + + $data = Utils::jsonDecode($json, true); + if (\is_array($data)) { + foreach ($data as $cookie) { + $this->setCookie(new SetCookie($cookie)); + } + } elseif (\is_scalar($data) && !empty($data)) { + throw new \RuntimeException("Invalid cookie file: {$filename}"); + } + } +} diff --git a/lib/guzzlehttp/guzzle/src/Cookie/SessionCookieJar.php b/lib/guzzlehttp/guzzle/src/Cookie/SessionCookieJar.php new file mode 100644 index 00000000..5d51ca98 --- /dev/null +++ b/lib/guzzlehttp/guzzle/src/Cookie/SessionCookieJar.php @@ -0,0 +1,77 @@ +sessionKey = $sessionKey; + $this->storeSessionCookies = $storeSessionCookies; + $this->load(); + } + + /** + * Saves cookies to session when shutting down + */ + public function __destruct() + { + $this->save(); + } + + /** + * Save cookies to the client session + */ + public function save(): void + { + $json = []; + /** @var SetCookie $cookie */ + foreach ($this as $cookie) { + if (CookieJar::shouldPersist($cookie, $this->storeSessionCookies)) { + $json[] = $cookie->toArray(); + } + } + + $_SESSION[$this->sessionKey] = \json_encode($json); + } + + /** + * Load the contents of the client session into the data array + */ + protected function load(): void + { + if (!isset($_SESSION[$this->sessionKey])) { + return; + } + $data = \json_decode($_SESSION[$this->sessionKey], true); + if (\is_array($data)) { + foreach ($data as $cookie) { + $this->setCookie(new SetCookie($cookie)); + } + } elseif (\strlen($data)) { + throw new \RuntimeException("Invalid cookie data"); + } + } +} diff --git a/lib/guzzlehttp/guzzle/src/Cookie/SetCookie.php b/lib/guzzlehttp/guzzle/src/Cookie/SetCookie.php new file mode 100644 index 00000000..7c04034d --- /dev/null +++ b/lib/guzzlehttp/guzzle/src/Cookie/SetCookie.php @@ -0,0 +1,444 @@ + null, + 'Value' => null, + 'Domain' => null, + 'Path' => '/', + 'Max-Age' => null, + 'Expires' => null, + 'Secure' => false, + 'Discard' => false, + 'HttpOnly' => false + ]; + + /** + * @var array Cookie data + */ + private $data; + + /** + * Create a new SetCookie object from a string. + * + * @param string $cookie Set-Cookie header string + */ + public static function fromString(string $cookie): self + { + // Create the default return array + $data = self::$defaults; + // Explode the cookie string using a series of semicolons + $pieces = \array_filter(\array_map('trim', \explode(';', $cookie))); + // The name of the cookie (first kvp) must exist and include an equal sign. + if (!isset($pieces[0]) || \strpos($pieces[0], '=') === false) { + return new self($data); + } + + // Add the cookie pieces into the parsed data array + foreach ($pieces as $part) { + $cookieParts = \explode('=', $part, 2); + $key = \trim($cookieParts[0]); + $value = isset($cookieParts[1]) + ? \trim($cookieParts[1], " \n\r\t\0\x0B") + : true; + + // Only check for non-cookies when cookies have been found + if (!isset($data['Name'])) { + $data['Name'] = $key; + $data['Value'] = $value; + } else { + foreach (\array_keys(self::$defaults) as $search) { + if (!\strcasecmp($search, $key)) { + $data[$search] = $value; + continue 2; + } + } + $data[$key] = $value; + } + } + + return new self($data); + } + + /** + * @param array $data Array of cookie data provided by a Cookie parser + */ + public function __construct(array $data = []) + { + /** @var array|null $replaced will be null in case of replace error */ + $replaced = \array_replace(self::$defaults, $data); + if ($replaced === null) { + throw new \InvalidArgumentException('Unable to replace the default values for the Cookie.'); + } + + $this->data = $replaced; + // Extract the Expires value and turn it into a UNIX timestamp if needed + if (!$this->getExpires() && $this->getMaxAge()) { + // Calculate the Expires date + $this->setExpires(\time() + $this->getMaxAge()); + } elseif (null !== ($expires = $this->getExpires()) && !\is_numeric($expires)) { + $this->setExpires($expires); + } + } + + public function __toString() + { + $str = $this->data['Name'] . '=' . ($this->data['Value'] ?? '') . '; '; + foreach ($this->data as $k => $v) { + if ($k !== 'Name' && $k !== 'Value' && $v !== null && $v !== false) { + if ($k === 'Expires') { + $str .= 'Expires=' . \gmdate('D, d M Y H:i:s \G\M\T', $v) . '; '; + } else { + $str .= ($v === true ? $k : "{$k}={$v}") . '; '; + } + } + } + + return \rtrim($str, '; '); + } + + public function toArray(): array + { + return $this->data; + } + + /** + * Get the cookie name. + * + * @return string + */ + public function getName() + { + return $this->data['Name']; + } + + /** + * Set the cookie name. + * + * @param string $name Cookie name + */ + public function setName($name): void + { + if (!is_string($name)) { + trigger_deprecation('guzzlehttp/guzzle', '7.4', 'Not passing a string to %s::%s() is deprecated and will cause an error in 8.0.', __CLASS__, __FUNCTION__); + } + + $this->data['Name'] = (string) $name; + } + + /** + * Get the cookie value. + * + * @return string|null + */ + public function getValue() + { + return $this->data['Value']; + } + + /** + * Set the cookie value. + * + * @param string $value Cookie value + */ + public function setValue($value): void + { + if (!is_string($value)) { + trigger_deprecation('guzzlehttp/guzzle', '7.4', 'Not passing a string to %s::%s() is deprecated and will cause an error in 8.0.', __CLASS__, __FUNCTION__); + } + + $this->data['Value'] = (string) $value; + } + + /** + * Get the domain. + * + * @return string|null + */ + public function getDomain() + { + return $this->data['Domain']; + } + + /** + * Set the domain of the cookie. + * + * @param string|null $domain + */ + public function setDomain($domain): void + { + if (!is_string($domain) && null !== $domain) { + trigger_deprecation('guzzlehttp/guzzle', '7.4', 'Not passing a string or null to %s::%s() is deprecated and will cause an error in 8.0.', __CLASS__, __FUNCTION__); + } + + $this->data['Domain'] = null === $domain ? null : (string) $domain; + } + + /** + * Get the path. + * + * @return string + */ + public function getPath() + { + return $this->data['Path']; + } + + /** + * Set the path of the cookie. + * + * @param string $path Path of the cookie + */ + public function setPath($path): void + { + if (!is_string($path)) { + trigger_deprecation('guzzlehttp/guzzle', '7.4', 'Not passing a string to %s::%s() is deprecated and will cause an error in 8.0.', __CLASS__, __FUNCTION__); + } + + $this->data['Path'] = (string) $path; + } + + /** + * Maximum lifetime of the cookie in seconds. + * + * @return int|null + */ + public function getMaxAge() + { + return null === $this->data['Max-Age'] ? null : (int) $this->data['Max-Age']; + } + + /** + * Set the max-age of the cookie. + * + * @param int|null $maxAge Max age of the cookie in seconds + */ + public function setMaxAge($maxAge): void + { + if (!is_int($maxAge) && null !== $maxAge) { + trigger_deprecation('guzzlehttp/guzzle', '7.4', 'Not passing an int or null to %s::%s() is deprecated and will cause an error in 8.0.', __CLASS__, __FUNCTION__); + } + + $this->data['Max-Age'] = $maxAge === null ? null : (int) $maxAge; + } + + /** + * The UNIX timestamp when the cookie Expires. + * + * @return string|int|null + */ + public function getExpires() + { + return $this->data['Expires']; + } + + /** + * Set the unix timestamp for which the cookie will expire. + * + * @param int|string|null $timestamp Unix timestamp or any English textual datetime description. + */ + public function setExpires($timestamp): void + { + if (!is_int($timestamp) && !is_string($timestamp) && null !== $timestamp) { + trigger_deprecation('guzzlehttp/guzzle', '7.4', 'Not passing an int, string or null to %s::%s() is deprecated and will cause an error in 8.0.', __CLASS__, __FUNCTION__); + } + + $this->data['Expires'] = null === $timestamp ? null : (\is_numeric($timestamp) ? (int) $timestamp : \strtotime((string) $timestamp)); + } + + /** + * Get whether or not this is a secure cookie. + * + * @return bool + */ + public function getSecure() + { + return $this->data['Secure']; + } + + /** + * Set whether or not the cookie is secure. + * + * @param bool $secure Set to true or false if secure + */ + public function setSecure($secure): void + { + if (!is_bool($secure)) { + trigger_deprecation('guzzlehttp/guzzle', '7.4', 'Not passing a bool to %s::%s() is deprecated and will cause an error in 8.0.', __CLASS__, __FUNCTION__); + } + + $this->data['Secure'] = (bool) $secure; + } + + /** + * Get whether or not this is a session cookie. + * + * @return bool|null + */ + public function getDiscard() + { + return $this->data['Discard']; + } + + /** + * Set whether or not this is a session cookie. + * + * @param bool $discard Set to true or false if this is a session cookie + */ + public function setDiscard($discard): void + { + if (!is_bool($discard)) { + trigger_deprecation('guzzlehttp/guzzle', '7.4', 'Not passing a bool to %s::%s() is deprecated and will cause an error in 8.0.', __CLASS__, __FUNCTION__); + } + + $this->data['Discard'] = (bool) $discard; + } + + /** + * Get whether or not this is an HTTP only cookie. + * + * @return bool + */ + public function getHttpOnly() + { + return $this->data['HttpOnly']; + } + + /** + * Set whether or not this is an HTTP only cookie. + * + * @param bool $httpOnly Set to true or false if this is HTTP only + */ + public function setHttpOnly($httpOnly): void + { + if (!is_bool($httpOnly)) { + trigger_deprecation('guzzlehttp/guzzle', '7.4', 'Not passing a bool to %s::%s() is deprecated and will cause an error in 8.0.', __CLASS__, __FUNCTION__); + } + + $this->data['HttpOnly'] = (bool) $httpOnly; + } + + /** + * Check if the cookie matches a path value. + * + * A request-path path-matches a given cookie-path if at least one of + * the following conditions holds: + * + * - The cookie-path and the request-path are identical. + * - The cookie-path is a prefix of the request-path, and the last + * character of the cookie-path is %x2F ("/"). + * - The cookie-path is a prefix of the request-path, and the first + * character of the request-path that is not included in the cookie- + * path is a %x2F ("/") character. + * + * @param string $requestPath Path to check against + */ + public function matchesPath(string $requestPath): bool + { + $cookiePath = $this->getPath(); + + // Match on exact matches or when path is the default empty "/" + if ($cookiePath === '/' || $cookiePath == $requestPath) { + return true; + } + + // Ensure that the cookie-path is a prefix of the request path. + if (0 !== \strpos($requestPath, $cookiePath)) { + return false; + } + + // Match if the last character of the cookie-path is "/" + if (\substr($cookiePath, -1, 1) === '/') { + return true; + } + + // Match if the first character not included in cookie path is "/" + return \substr($requestPath, \strlen($cookiePath), 1) === '/'; + } + + /** + * Check if the cookie matches a domain value. + * + * @param string $domain Domain to check against + */ + public function matchesDomain(string $domain): bool + { + $cookieDomain = $this->getDomain(); + if (null === $cookieDomain) { + return true; + } + + // Remove the leading '.' as per spec in RFC 6265. + // https://tools.ietf.org/html/rfc6265#section-5.2.3 + $cookieDomain = \ltrim($cookieDomain, '.'); + + // Domain not set or exact match. + if (!$cookieDomain || !\strcasecmp($domain, $cookieDomain)) { + return true; + } + + // Matching the subdomain according to RFC 6265. + // https://tools.ietf.org/html/rfc6265#section-5.1.3 + if (\filter_var($domain, \FILTER_VALIDATE_IP)) { + return false; + } + + return (bool) \preg_match('/\.' . \preg_quote($cookieDomain, '/') . '$/', $domain); + } + + /** + * Check if the cookie is expired. + */ + public function isExpired(): bool + { + return $this->getExpires() !== null && \time() > $this->getExpires(); + } + + /** + * Check if the cookie is valid according to RFC 6265. + * + * @return bool|string Returns true if valid or an error message if invalid + */ + public function validate() + { + $name = $this->getName(); + if ($name === '') { + return 'The cookie name must not be empty'; + } + + // Check if any of the invalid characters are present in the cookie name + if (\preg_match( + '/[\x00-\x20\x22\x28-\x29\x2c\x2f\x3a-\x40\x5c\x7b\x7d\x7f]/', + $name + )) { + return 'Cookie name must not contain invalid characters: ASCII ' + . 'Control characters (0-31;127), space, tab and the ' + . 'following characters: ()<>@,;:\"/?={}'; + } + + // Value must not be null. 0 and empty string are valid. Empty strings + // are technically against RFC 6265, but known to happen in the wild. + $value = $this->getValue(); + if ($value === null) { + return 'The cookie value must not be empty'; + } + + // Domains must not be empty, but can be 0. "0" is not a valid internet + // domain, but may be used as server name in a private network. + $domain = $this->getDomain(); + if ($domain === null || $domain === '') { + return 'The cookie domain must not be empty'; + } + + return true; + } +} diff --git a/lib/guzzlehttp/guzzle/src/Exception/BadResponseException.php b/lib/guzzlehttp/guzzle/src/Exception/BadResponseException.php new file mode 100644 index 00000000..a80956c9 --- /dev/null +++ b/lib/guzzlehttp/guzzle/src/Exception/BadResponseException.php @@ -0,0 +1,39 @@ +request = $request; + $this->handlerContext = $handlerContext; + } + + /** + * Get the request that caused the exception + */ + public function getRequest(): RequestInterface + { + return $this->request; + } + + /** + * Get contextual information about the error from the underlying handler. + * + * The contents of this array will vary depending on which handler you are + * using. It may also be just an empty array. Relying on this data will + * couple you to a specific handler, but can give more debug information + * when needed. + */ + public function getHandlerContext(): array + { + return $this->handlerContext; + } +} diff --git a/lib/guzzlehttp/guzzle/src/Exception/GuzzleException.php b/lib/guzzlehttp/guzzle/src/Exception/GuzzleException.php new file mode 100644 index 00000000..fa3ed699 --- /dev/null +++ b/lib/guzzlehttp/guzzle/src/Exception/GuzzleException.php @@ -0,0 +1,9 @@ +getStatusCode() : 0; + parent::__construct($message, $code, $previous); + $this->request = $request; + $this->response = $response; + $this->handlerContext = $handlerContext; + } + + /** + * Wrap non-RequestExceptions with a RequestException + */ + public static function wrapException(RequestInterface $request, \Throwable $e): RequestException + { + return $e instanceof RequestException ? $e : new RequestException($e->getMessage(), $request, null, $e); + } + + /** + * Factory method to create a new exception with a normalized error message + * + * @param RequestInterface $request Request sent + * @param ResponseInterface $response Response received + * @param \Throwable|null $previous Previous exception + * @param array $handlerContext Optional handler context + * @param BodySummarizerInterface|null $bodySummarizer Optional body summarizer + */ + public static function create( + RequestInterface $request, + ResponseInterface $response = null, + \Throwable $previous = null, + array $handlerContext = [], + BodySummarizerInterface $bodySummarizer = null + ): self { + if (!$response) { + return new self( + 'Error completing request', + $request, + null, + $previous, + $handlerContext + ); + } + + $level = (int) \floor($response->getStatusCode() / 100); + if ($level === 4) { + $label = 'Client error'; + $className = ClientException::class; + } elseif ($level === 5) { + $label = 'Server error'; + $className = ServerException::class; + } else { + $label = 'Unsuccessful request'; + $className = __CLASS__; + } + + $uri = $request->getUri(); + $uri = static::obfuscateUri($uri); + + // Client Error: `GET /` resulted in a `404 Not Found` response: + // ... (truncated) + $message = \sprintf( + '%s: `%s %s` resulted in a `%s %s` response', + $label, + $request->getMethod(), + $uri, + $response->getStatusCode(), + $response->getReasonPhrase() + ); + + $summary = ($bodySummarizer ?? new BodySummarizer())->summarize($response); + + if ($summary !== null) { + $message .= ":\n{$summary}\n"; + } + + return new $className($message, $request, $response, $previous, $handlerContext); + } + + /** + * Obfuscates URI if there is a username and a password present + */ + private static function obfuscateUri(UriInterface $uri): UriInterface + { + $userInfo = $uri->getUserInfo(); + + if (false !== ($pos = \strpos($userInfo, ':'))) { + return $uri->withUserInfo(\substr($userInfo, 0, $pos), '***'); + } + + return $uri; + } + + /** + * Get the request that caused the exception + */ + public function getRequest(): RequestInterface + { + return $this->request; + } + + /** + * Get the associated response + */ + public function getResponse(): ?ResponseInterface + { + return $this->response; + } + + /** + * Check if a response was received + */ + public function hasResponse(): bool + { + return $this->response !== null; + } + + /** + * Get contextual information about the error from the underlying handler. + * + * The contents of this array will vary depending on which handler you are + * using. It may also be just an empty array. Relying on this data will + * couple you to a specific handler, but can give more debug information + * when needed. + */ + public function getHandlerContext(): array + { + return $this->handlerContext; + } +} diff --git a/lib/guzzlehttp/guzzle/src/Exception/ServerException.php b/lib/guzzlehttp/guzzle/src/Exception/ServerException.php new file mode 100644 index 00000000..8055e067 --- /dev/null +++ b/lib/guzzlehttp/guzzle/src/Exception/ServerException.php @@ -0,0 +1,10 @@ +maxHandles = $maxHandles; + } + + public function create(RequestInterface $request, array $options): EasyHandle + { + if (isset($options['curl']['body_as_string'])) { + $options['_body_as_string'] = $options['curl']['body_as_string']; + unset($options['curl']['body_as_string']); + } + + $easy = new EasyHandle; + $easy->request = $request; + $easy->options = $options; + $conf = $this->getDefaultConf($easy); + $this->applyMethod($easy, $conf); + $this->applyHandlerOptions($easy, $conf); + $this->applyHeaders($easy, $conf); + unset($conf['_headers']); + + // Add handler options from the request configuration options + if (isset($options['curl'])) { + $conf = \array_replace($conf, $options['curl']); + } + + $conf[\CURLOPT_HEADERFUNCTION] = $this->createHeaderFn($easy); + $easy->handle = $this->handles ? \array_pop($this->handles) : \curl_init(); + curl_setopt_array($easy->handle, $conf); + + return $easy; + } + + public function release(EasyHandle $easy): void + { + $resource = $easy->handle; + unset($easy->handle); + + if (\count($this->handles) >= $this->maxHandles) { + \curl_close($resource); + } else { + // Remove all callback functions as they can hold onto references + // and are not cleaned up by curl_reset. Using curl_setopt_array + // does not work for some reason, so removing each one + // individually. + \curl_setopt($resource, \CURLOPT_HEADERFUNCTION, null); + \curl_setopt($resource, \CURLOPT_READFUNCTION, null); + \curl_setopt($resource, \CURLOPT_WRITEFUNCTION, null); + \curl_setopt($resource, \CURLOPT_PROGRESSFUNCTION, null); + \curl_reset($resource); + $this->handles[] = $resource; + } + } + + /** + * Completes a cURL transaction, either returning a response promise or a + * rejected promise. + * + * @param callable(RequestInterface, array): PromiseInterface $handler + * @param CurlFactoryInterface $factory Dictates how the handle is released + */ + public static function finish(callable $handler, EasyHandle $easy, CurlFactoryInterface $factory): PromiseInterface + { + if (isset($easy->options['on_stats'])) { + self::invokeStats($easy); + } + + if (!$easy->response || $easy->errno) { + return self::finishError($handler, $easy, $factory); + } + + // Return the response if it is present and there is no error. + $factory->release($easy); + + // Rewind the body of the response if possible. + $body = $easy->response->getBody(); + if ($body->isSeekable()) { + $body->rewind(); + } + + return new FulfilledPromise($easy->response); + } + + private static function invokeStats(EasyHandle $easy): void + { + $curlStats = \curl_getinfo($easy->handle); + $curlStats['appconnect_time'] = \curl_getinfo($easy->handle, \CURLINFO_APPCONNECT_TIME); + $stats = new TransferStats( + $easy->request, + $easy->response, + $curlStats['total_time'], + $easy->errno, + $curlStats + ); + ($easy->options['on_stats'])($stats); + } + + /** + * @param callable(RequestInterface, array): PromiseInterface $handler + */ + private static function finishError(callable $handler, EasyHandle $easy, CurlFactoryInterface $factory): PromiseInterface + { + // Get error information and release the handle to the factory. + $ctx = [ + 'errno' => $easy->errno, + 'error' => \curl_error($easy->handle), + 'appconnect_time' => \curl_getinfo($easy->handle, \CURLINFO_APPCONNECT_TIME), + ] + \curl_getinfo($easy->handle); + $ctx[self::CURL_VERSION_STR] = \curl_version()['version']; + $factory->release($easy); + + // Retry when nothing is present or when curl failed to rewind. + if (empty($easy->options['_err_message']) && (!$easy->errno || $easy->errno == 65)) { + return self::retryFailedRewind($handler, $easy, $ctx); + } + + return self::createRejection($easy, $ctx); + } + + private static function createRejection(EasyHandle $easy, array $ctx): PromiseInterface + { + static $connectionErrors = [ + \CURLE_OPERATION_TIMEOUTED => true, + \CURLE_COULDNT_RESOLVE_HOST => true, + \CURLE_COULDNT_CONNECT => true, + \CURLE_SSL_CONNECT_ERROR => true, + \CURLE_GOT_NOTHING => true, + ]; + + if ($easy->createResponseException) { + return P\Create::rejectionFor( + new RequestException( + 'An error was encountered while creating the response', + $easy->request, + $easy->response, + $easy->createResponseException, + $ctx + ) + ); + } + + // If an exception was encountered during the onHeaders event, then + // return a rejected promise that wraps that exception. + if ($easy->onHeadersException) { + return P\Create::rejectionFor( + new RequestException( + 'An error was encountered during the on_headers event', + $easy->request, + $easy->response, + $easy->onHeadersException, + $ctx + ) + ); + } + + $message = \sprintf( + 'cURL error %s: %s (%s)', + $ctx['errno'], + $ctx['error'], + 'see https://curl.haxx.se/libcurl/c/libcurl-errors.html' + ); + $uriString = (string) $easy->request->getUri(); + if ($uriString !== '' && false === \strpos($ctx['error'], $uriString)) { + $message .= \sprintf(' for %s', $uriString); + } + + // Create a connection exception if it was a specific error code. + $error = isset($connectionErrors[$easy->errno]) + ? new ConnectException($message, $easy->request, null, $ctx) + : new RequestException($message, $easy->request, $easy->response, null, $ctx); + + return P\Create::rejectionFor($error); + } + + /** + * @return array + */ + private function getDefaultConf(EasyHandle $easy): array + { + $conf = [ + '_headers' => $easy->request->getHeaders(), + \CURLOPT_CUSTOMREQUEST => $easy->request->getMethod(), + \CURLOPT_URL => (string) $easy->request->getUri()->withFragment(''), + \CURLOPT_RETURNTRANSFER => false, + \CURLOPT_HEADER => false, + \CURLOPT_CONNECTTIMEOUT => 150, + ]; + + if (\defined('CURLOPT_PROTOCOLS')) { + $conf[\CURLOPT_PROTOCOLS] = \CURLPROTO_HTTP | \CURLPROTO_HTTPS; + } + + $version = $easy->request->getProtocolVersion(); + if ($version == 1.1) { + $conf[\CURLOPT_HTTP_VERSION] = \CURL_HTTP_VERSION_1_1; + } elseif ($version == 2.0) { + $conf[\CURLOPT_HTTP_VERSION] = \CURL_HTTP_VERSION_2_0; + } else { + $conf[\CURLOPT_HTTP_VERSION] = \CURL_HTTP_VERSION_1_0; + } + + return $conf; + } + + private function applyMethod(EasyHandle $easy, array &$conf): void + { + $body = $easy->request->getBody(); + $size = $body->getSize(); + + if ($size === null || $size > 0) { + $this->applyBody($easy->request, $easy->options, $conf); + return; + } + + $method = $easy->request->getMethod(); + if ($method === 'PUT' || $method === 'POST') { + // See https://tools.ietf.org/html/rfc7230#section-3.3.2 + if (!$easy->request->hasHeader('Content-Length')) { + $conf[\CURLOPT_HTTPHEADER][] = 'Content-Length: 0'; + } + } elseif ($method === 'HEAD') { + $conf[\CURLOPT_NOBODY] = true; + unset( + $conf[\CURLOPT_WRITEFUNCTION], + $conf[\CURLOPT_READFUNCTION], + $conf[\CURLOPT_FILE], + $conf[\CURLOPT_INFILE] + ); + } + } + + private function applyBody(RequestInterface $request, array $options, array &$conf): void + { + $size = $request->hasHeader('Content-Length') + ? (int) $request->getHeaderLine('Content-Length') + : null; + + // Send the body as a string if the size is less than 1MB OR if the + // [curl][body_as_string] request value is set. + if (($size !== null && $size < 1000000) || !empty($options['_body_as_string'])) { + $conf[\CURLOPT_POSTFIELDS] = (string) $request->getBody(); + // Don't duplicate the Content-Length header + $this->removeHeader('Content-Length', $conf); + $this->removeHeader('Transfer-Encoding', $conf); + } else { + $conf[\CURLOPT_UPLOAD] = true; + if ($size !== null) { + $conf[\CURLOPT_INFILESIZE] = $size; + $this->removeHeader('Content-Length', $conf); + } + $body = $request->getBody(); + if ($body->isSeekable()) { + $body->rewind(); + } + $conf[\CURLOPT_READFUNCTION] = static function ($ch, $fd, $length) use ($body) { + return $body->read($length); + }; + } + + // If the Expect header is not present, prevent curl from adding it + if (!$request->hasHeader('Expect')) { + $conf[\CURLOPT_HTTPHEADER][] = 'Expect:'; + } + + // cURL sometimes adds a content-type by default. Prevent this. + if (!$request->hasHeader('Content-Type')) { + $conf[\CURLOPT_HTTPHEADER][] = 'Content-Type:'; + } + } + + private function applyHeaders(EasyHandle $easy, array &$conf): void + { + foreach ($conf['_headers'] as $name => $values) { + foreach ($values as $value) { + $value = (string) $value; + if ($value === '') { + // cURL requires a special format for empty headers. + // See https://github.com/guzzle/guzzle/issues/1882 for more details. + $conf[\CURLOPT_HTTPHEADER][] = "$name;"; + } else { + $conf[\CURLOPT_HTTPHEADER][] = "$name: $value"; + } + } + } + + // Remove the Accept header if one was not set + if (!$easy->request->hasHeader('Accept')) { + $conf[\CURLOPT_HTTPHEADER][] = 'Accept:'; + } + } + + /** + * Remove a header from the options array. + * + * @param string $name Case-insensitive header to remove + * @param array $options Array of options to modify + */ + private function removeHeader(string $name, array &$options): void + { + foreach (\array_keys($options['_headers']) as $key) { + if (!\strcasecmp($key, $name)) { + unset($options['_headers'][$key]); + return; + } + } + } + + private function applyHandlerOptions(EasyHandle $easy, array &$conf): void + { + $options = $easy->options; + if (isset($options['verify'])) { + if ($options['verify'] === false) { + unset($conf[\CURLOPT_CAINFO]); + $conf[\CURLOPT_SSL_VERIFYHOST] = 0; + $conf[\CURLOPT_SSL_VERIFYPEER] = false; + } else { + $conf[\CURLOPT_SSL_VERIFYHOST] = 2; + $conf[\CURLOPT_SSL_VERIFYPEER] = true; + if (\is_string($options['verify'])) { + // Throw an error if the file/folder/link path is not valid or doesn't exist. + if (!\file_exists($options['verify'])) { + throw new \InvalidArgumentException("SSL CA bundle not found: {$options['verify']}"); + } + // If it's a directory or a link to a directory use CURLOPT_CAPATH. + // If not, it's probably a file, or a link to a file, so use CURLOPT_CAINFO. + if ( + \is_dir($options['verify']) || + ( + \is_link($options['verify']) === true && + ($verifyLink = \readlink($options['verify'])) !== false && + \is_dir($verifyLink) + ) + ) { + $conf[\CURLOPT_CAPATH] = $options['verify']; + } else { + $conf[\CURLOPT_CAINFO] = $options['verify']; + } + } + } + } + + if (!isset($options['curl'][\CURLOPT_ENCODING]) && !empty($options['decode_content'])) { + $accept = $easy->request->getHeaderLine('Accept-Encoding'); + if ($accept) { + $conf[\CURLOPT_ENCODING] = $accept; + } else { + // The empty string enables all available decoders and implicitly + // sets a matching 'Accept-Encoding' header. + $conf[\CURLOPT_ENCODING] = ''; + // But as the user did not specify any acceptable encodings we need + // to overwrite this implicit header with an empty one. + $conf[\CURLOPT_HTTPHEADER][] = 'Accept-Encoding:'; + } + } + + if (!isset($options['sink'])) { + // Use a default temp stream if no sink was set. + $options['sink'] = \GuzzleHttp\Psr7\Utils::tryFopen('php://temp', 'w+'); + } + $sink = $options['sink']; + if (!\is_string($sink)) { + $sink = \GuzzleHttp\Psr7\Utils::streamFor($sink); + } elseif (!\is_dir(\dirname($sink))) { + // Ensure that the directory exists before failing in curl. + throw new \RuntimeException(\sprintf('Directory %s does not exist for sink value of %s', \dirname($sink), $sink)); + } else { + $sink = new LazyOpenStream($sink, 'w+'); + } + $easy->sink = $sink; + $conf[\CURLOPT_WRITEFUNCTION] = static function ($ch, $write) use ($sink): int { + return $sink->write($write); + }; + + $timeoutRequiresNoSignal = false; + if (isset($options['timeout'])) { + $timeoutRequiresNoSignal |= $options['timeout'] < 1; + $conf[\CURLOPT_TIMEOUT_MS] = $options['timeout'] * 1000; + } + + // CURL default value is CURL_IPRESOLVE_WHATEVER + if (isset($options['force_ip_resolve'])) { + if ('v4' === $options['force_ip_resolve']) { + $conf[\CURLOPT_IPRESOLVE] = \CURL_IPRESOLVE_V4; + } elseif ('v6' === $options['force_ip_resolve']) { + $conf[\CURLOPT_IPRESOLVE] = \CURL_IPRESOLVE_V6; + } + } + + if (isset($options['connect_timeout'])) { + $timeoutRequiresNoSignal |= $options['connect_timeout'] < 1; + $conf[\CURLOPT_CONNECTTIMEOUT_MS] = $options['connect_timeout'] * 1000; + } + + if ($timeoutRequiresNoSignal && \strtoupper(\substr(\PHP_OS, 0, 3)) !== 'WIN') { + $conf[\CURLOPT_NOSIGNAL] = true; + } + + if (isset($options['proxy'])) { + if (!\is_array($options['proxy'])) { + $conf[\CURLOPT_PROXY] = $options['proxy']; + } else { + $scheme = $easy->request->getUri()->getScheme(); + if (isset($options['proxy'][$scheme])) { + $host = $easy->request->getUri()->getHost(); + if (!isset($options['proxy']['no']) || !Utils::isHostInNoProxy($host, $options['proxy']['no'])) { + $conf[\CURLOPT_PROXY] = $options['proxy'][$scheme]; + } + } + } + } + + if (isset($options['cert'])) { + $cert = $options['cert']; + if (\is_array($cert)) { + $conf[\CURLOPT_SSLCERTPASSWD] = $cert[1]; + $cert = $cert[0]; + } + if (!\file_exists($cert)) { + throw new \InvalidArgumentException("SSL certificate not found: {$cert}"); + } + # OpenSSL (versions 0.9.3 and later) also support "P12" for PKCS#12-encoded files. + # see https://curl.se/libcurl/c/CURLOPT_SSLCERTTYPE.html + $ext = pathinfo($cert, \PATHINFO_EXTENSION); + if (preg_match('#^(der|p12)$#i', $ext)) { + $conf[\CURLOPT_SSLCERTTYPE] = strtoupper($ext); + } + $conf[\CURLOPT_SSLCERT] = $cert; + } + + if (isset($options['ssl_key'])) { + if (\is_array($options['ssl_key'])) { + if (\count($options['ssl_key']) === 2) { + [$sslKey, $conf[\CURLOPT_SSLKEYPASSWD]] = $options['ssl_key']; + } else { + [$sslKey] = $options['ssl_key']; + } + } + + $sslKey = $sslKey ?? $options['ssl_key']; + + if (!\file_exists($sslKey)) { + throw new \InvalidArgumentException("SSL private key not found: {$sslKey}"); + } + $conf[\CURLOPT_SSLKEY] = $sslKey; + } + + if (isset($options['progress'])) { + $progress = $options['progress']; + if (!\is_callable($progress)) { + throw new \InvalidArgumentException('progress client option must be callable'); + } + $conf[\CURLOPT_NOPROGRESS] = false; + $conf[\CURLOPT_PROGRESSFUNCTION] = static function ($resource, int $downloadSize, int $downloaded, int $uploadSize, int $uploaded) use ($progress) { + $progress($downloadSize, $downloaded, $uploadSize, $uploaded); + }; + } + + if (!empty($options['debug'])) { + $conf[\CURLOPT_STDERR] = Utils::debugResource($options['debug']); + $conf[\CURLOPT_VERBOSE] = true; + } + } + + /** + * This function ensures that a response was set on a transaction. If one + * was not set, then the request is retried if possible. This error + * typically means you are sending a payload, curl encountered a + * "Connection died, retrying a fresh connect" error, tried to rewind the + * stream, and then encountered a "necessary data rewind wasn't possible" + * error, causing the request to be sent through curl_multi_info_read() + * without an error status. + * + * @param callable(RequestInterface, array): PromiseInterface $handler + */ + private static function retryFailedRewind(callable $handler, EasyHandle $easy, array $ctx): PromiseInterface + { + try { + // Only rewind if the body has been read from. + $body = $easy->request->getBody(); + if ($body->tell() > 0) { + $body->rewind(); + } + } catch (\RuntimeException $e) { + $ctx['error'] = 'The connection unexpectedly failed without ' + . 'providing an error. The request would have been retried, ' + . 'but attempting to rewind the request body failed. ' + . 'Exception: ' . $e; + return self::createRejection($easy, $ctx); + } + + // Retry no more than 3 times before giving up. + if (!isset($easy->options['_curl_retries'])) { + $easy->options['_curl_retries'] = 1; + } elseif ($easy->options['_curl_retries'] == 2) { + $ctx['error'] = 'The cURL request was retried 3 times ' + . 'and did not succeed. The most likely reason for the failure ' + . 'is that cURL was unable to rewind the body of the request ' + . 'and subsequent retries resulted in the same error. Turn on ' + . 'the debug option to see what went wrong. See ' + . 'https://bugs.php.net/bug.php?id=47204 for more information.'; + return self::createRejection($easy, $ctx); + } else { + $easy->options['_curl_retries']++; + } + + return $handler($easy->request, $easy->options); + } + + private function createHeaderFn(EasyHandle $easy): callable + { + if (isset($easy->options['on_headers'])) { + $onHeaders = $easy->options['on_headers']; + + if (!\is_callable($onHeaders)) { + throw new \InvalidArgumentException('on_headers must be callable'); + } + } else { + $onHeaders = null; + } + + return static function ($ch, $h) use ( + $onHeaders, + $easy, + &$startingResponse + ) { + $value = \trim($h); + if ($value === '') { + $startingResponse = true; + try { + $easy->createResponse(); + } catch (\Exception $e) { + $easy->createResponseException = $e; + return -1; + } + if ($onHeaders !== null) { + try { + $onHeaders($easy->response); + } catch (\Exception $e) { + // Associate the exception with the handle and trigger + // a curl header write error by returning 0. + $easy->onHeadersException = $e; + return -1; + } + } + } elseif ($startingResponse) { + $startingResponse = false; + $easy->headers = [$value]; + } else { + $easy->headers[] = $value; + } + return \strlen($h); + }; + } +} diff --git a/lib/guzzlehttp/guzzle/src/Handler/CurlFactoryInterface.php b/lib/guzzlehttp/guzzle/src/Handler/CurlFactoryInterface.php new file mode 100644 index 00000000..fe57ed5d --- /dev/null +++ b/lib/guzzlehttp/guzzle/src/Handler/CurlFactoryInterface.php @@ -0,0 +1,25 @@ +factory = $options['handle_factory'] + ?? new CurlFactory(3); + } + + public function __invoke(RequestInterface $request, array $options): PromiseInterface + { + if (isset($options['delay'])) { + \usleep($options['delay'] * 1000); + } + + $easy = $this->factory->create($request, $options); + \curl_exec($easy->handle); + $easy->errno = \curl_errno($easy->handle); + + return CurlFactory::finish($this, $easy, $this->factory); + } +} diff --git a/lib/guzzlehttp/guzzle/src/Handler/CurlMultiHandler.php b/lib/guzzlehttp/guzzle/src/Handler/CurlMultiHandler.php new file mode 100644 index 00000000..ace0d840 --- /dev/null +++ b/lib/guzzlehttp/guzzle/src/Handler/CurlMultiHandler.php @@ -0,0 +1,257 @@ + An array of delay times, indexed by handle id in `addRequest`. + * + * @see CurlMultiHandler::addRequest + */ + private $delays = []; + + /** + * @var array An associative array of CURLMOPT_* options and corresponding values for curl_multi_setopt() + */ + private $options = []; + + /** + * This handler accepts the following options: + * + * - handle_factory: An optional factory used to create curl handles + * - select_timeout: Optional timeout (in seconds) to block before timing + * out while selecting curl handles. Defaults to 1 second. + * - options: An associative array of CURLMOPT_* options and + * corresponding values for curl_multi_setopt() + */ + public function __construct(array $options = []) + { + $this->factory = $options['handle_factory'] ?? new CurlFactory(50); + + if (isset($options['select_timeout'])) { + $this->selectTimeout = $options['select_timeout']; + } elseif ($selectTimeout = Utils::getenv('GUZZLE_CURL_SELECT_TIMEOUT')) { + @trigger_error('Since guzzlehttp/guzzle 7.2.0: Using environment variable GUZZLE_CURL_SELECT_TIMEOUT is deprecated. Use option "select_timeout" instead.', \E_USER_DEPRECATED); + $this->selectTimeout = (int) $selectTimeout; + } else { + $this->selectTimeout = 1; + } + + $this->options = $options['options'] ?? []; + } + + /** + * @param string $name + * + * @return resource|\CurlMultiHandle + * + * @throws \BadMethodCallException when another field as `_mh` will be gotten + * @throws \RuntimeException when curl can not initialize a multi handle + */ + public function __get($name) + { + if ($name !== '_mh') { + throw new \BadMethodCallException("Can not get other property as '_mh'."); + } + + $multiHandle = \curl_multi_init(); + + if (false === $multiHandle) { + throw new \RuntimeException('Can not initialize curl multi handle.'); + } + + $this->_mh = $multiHandle; + + foreach ($this->options as $option => $value) { + // A warning is raised in case of a wrong option. + curl_multi_setopt($this->_mh, $option, $value); + } + + return $this->_mh; + } + + public function __destruct() + { + if (isset($this->_mh)) { + \curl_multi_close($this->_mh); + unset($this->_mh); + } + } + + public function __invoke(RequestInterface $request, array $options): PromiseInterface + { + $easy = $this->factory->create($request, $options); + $id = (int) $easy->handle; + + $promise = new Promise( + [$this, 'execute'], + function () use ($id) { + return $this->cancel($id); + } + ); + + $this->addRequest(['easy' => $easy, 'deferred' => $promise]); + + return $promise; + } + + /** + * Ticks the curl event loop. + */ + public function tick(): void + { + // Add any delayed handles if needed. + if ($this->delays) { + $currentTime = Utils::currentTime(); + foreach ($this->delays as $id => $delay) { + if ($currentTime >= $delay) { + unset($this->delays[$id]); + \curl_multi_add_handle( + $this->_mh, + $this->handles[$id]['easy']->handle + ); + } + } + } + + // Step through the task queue which may add additional requests. + P\Utils::queue()->run(); + + if ($this->active && \curl_multi_select($this->_mh, $this->selectTimeout) === -1) { + // Perform a usleep if a select returns -1. + // See: https://bugs.php.net/bug.php?id=61141 + \usleep(250); + } + + while (\curl_multi_exec($this->_mh, $this->active) === \CURLM_CALL_MULTI_PERFORM); + + $this->processMessages(); + } + + /** + * Runs until all outstanding connections have completed. + */ + public function execute(): void + { + $queue = P\Utils::queue(); + + while ($this->handles || !$queue->isEmpty()) { + // If there are no transfers, then sleep for the next delay + if (!$this->active && $this->delays) { + \usleep($this->timeToNext()); + } + $this->tick(); + } + } + + private function addRequest(array $entry): void + { + $easy = $entry['easy']; + $id = (int) $easy->handle; + $this->handles[$id] = $entry; + if (empty($easy->options['delay'])) { + \curl_multi_add_handle($this->_mh, $easy->handle); + } else { + $this->delays[$id] = Utils::currentTime() + ($easy->options['delay'] / 1000); + } + } + + /** + * Cancels a handle from sending and removes references to it. + * + * @param int $id Handle ID to cancel and remove. + * + * @return bool True on success, false on failure. + */ + private function cancel($id): bool + { + if (!is_int($id)) { + trigger_deprecation('guzzlehttp/guzzle', '7.4', 'Not passing an integer to %s::%s() is deprecated and will cause an error in 8.0.', __CLASS__, __FUNCTION__); + } + + // Cannot cancel if it has been processed. + if (!isset($this->handles[$id])) { + return false; + } + + $handle = $this->handles[$id]['easy']->handle; + unset($this->delays[$id], $this->handles[$id]); + \curl_multi_remove_handle($this->_mh, $handle); + \curl_close($handle); + + return true; + } + + private function processMessages(): void + { + while ($done = \curl_multi_info_read($this->_mh)) { + $id = (int) $done['handle']; + \curl_multi_remove_handle($this->_mh, $done['handle']); + + if (!isset($this->handles[$id])) { + // Probably was cancelled. + continue; + } + + $entry = $this->handles[$id]; + unset($this->handles[$id], $this->delays[$id]); + $entry['easy']->errno = $done['result']; + $entry['deferred']->resolve( + CurlFactory::finish($this, $entry['easy'], $this->factory) + ); + } + } + + private function timeToNext(): int + { + $currentTime = Utils::currentTime(); + $nextTime = \PHP_INT_MAX; + foreach ($this->delays as $time) { + if ($time < $nextTime) { + $nextTime = $time; + } + } + + return ((int) \max(0, $nextTime - $currentTime)) * 1000000; + } +} diff --git a/lib/guzzlehttp/guzzle/src/Handler/EasyHandle.php b/lib/guzzlehttp/guzzle/src/Handler/EasyHandle.php new file mode 100644 index 00000000..224344d7 --- /dev/null +++ b/lib/guzzlehttp/guzzle/src/Handler/EasyHandle.php @@ -0,0 +1,112 @@ +headers); + + $normalizedKeys = Utils::normalizeHeaderKeys($headers); + + if (!empty($this->options['decode_content']) && isset($normalizedKeys['content-encoding'])) { + $headers['x-encoded-content-encoding'] = $headers[$normalizedKeys['content-encoding']]; + unset($headers[$normalizedKeys['content-encoding']]); + if (isset($normalizedKeys['content-length'])) { + $headers['x-encoded-content-length'] = $headers[$normalizedKeys['content-length']]; + + $bodyLength = (int) $this->sink->getSize(); + if ($bodyLength) { + $headers[$normalizedKeys['content-length']] = $bodyLength; + } else { + unset($headers[$normalizedKeys['content-length']]); + } + } + } + + // Attach a response to the easy handle with the parsed headers. + $this->response = new Response( + $status, + $headers, + $this->sink, + $ver, + $reason + ); + } + + /** + * @param string $name + * + * @return void + * + * @throws \BadMethodCallException + */ + public function __get($name) + { + $msg = $name === 'handle' ? 'The EasyHandle has been released' : 'Invalid property: ' . $name; + throw new \BadMethodCallException($msg); + } +} diff --git a/lib/guzzlehttp/guzzle/src/Handler/HeaderProcessor.php b/lib/guzzlehttp/guzzle/src/Handler/HeaderProcessor.php new file mode 100644 index 00000000..a0988845 --- /dev/null +++ b/lib/guzzlehttp/guzzle/src/Handler/HeaderProcessor.php @@ -0,0 +1,42 @@ +|null $queue The parameters to be passed to the append function, as an indexed array. + * @param callable|null $onFulfilled Callback to invoke when the return value is fulfilled. + * @param callable|null $onRejected Callback to invoke when the return value is rejected. + */ + public function __construct(array $queue = null, callable $onFulfilled = null, callable $onRejected = null) + { + $this->onFulfilled = $onFulfilled; + $this->onRejected = $onRejected; + + if ($queue) { + // array_values included for BC + $this->append(...array_values($queue)); + } + } + + public function __invoke(RequestInterface $request, array $options): PromiseInterface + { + if (!$this->queue) { + throw new \OutOfBoundsException('Mock queue is empty'); + } + + if (isset($options['delay']) && \is_numeric($options['delay'])) { + \usleep((int) $options['delay'] * 1000); + } + + $this->lastRequest = $request; + $this->lastOptions = $options; + $response = \array_shift($this->queue); + + if (isset($options['on_headers'])) { + if (!\is_callable($options['on_headers'])) { + throw new \InvalidArgumentException('on_headers must be callable'); + } + try { + $options['on_headers']($response); + } catch (\Exception $e) { + $msg = 'An error was encountered during the on_headers event'; + $response = new RequestException($msg, $request, $response, $e); + } + } + + if (\is_callable($response)) { + $response = $response($request, $options); + } + + $response = $response instanceof \Throwable + ? P\Create::rejectionFor($response) + : P\Create::promiseFor($response); + + return $response->then( + function (?ResponseInterface $value) use ($request, $options) { + $this->invokeStats($request, $options, $value); + if ($this->onFulfilled) { + ($this->onFulfilled)($value); + } + + if ($value !== null && isset($options['sink'])) { + $contents = (string) $value->getBody(); + $sink = $options['sink']; + + if (\is_resource($sink)) { + \fwrite($sink, $contents); + } elseif (\is_string($sink)) { + \file_put_contents($sink, $contents); + } elseif ($sink instanceof StreamInterface) { + $sink->write($contents); + } + } + + return $value; + }, + function ($reason) use ($request, $options) { + $this->invokeStats($request, $options, null, $reason); + if ($this->onRejected) { + ($this->onRejected)($reason); + } + return P\Create::rejectionFor($reason); + } + ); + } + + /** + * Adds one or more variadic requests, exceptions, callables, or promises + * to the queue. + * + * @param mixed ...$values + */ + public function append(...$values): void + { + foreach ($values as $value) { + if ($value instanceof ResponseInterface + || $value instanceof \Throwable + || $value instanceof PromiseInterface + || \is_callable($value) + ) { + $this->queue[] = $value; + } else { + throw new \TypeError('Expected a Response, Promise, Throwable or callable. Found ' . Utils::describeType($value)); + } + } + } + + /** + * Get the last received request. + */ + public function getLastRequest(): ?RequestInterface + { + return $this->lastRequest; + } + + /** + * Get the last received request options. + */ + public function getLastOptions(): array + { + return $this->lastOptions; + } + + /** + * Returns the number of remaining items in the queue. + */ + public function count(): int + { + return \count($this->queue); + } + + public function reset(): void + { + $this->queue = []; + } + + /** + * @param mixed $reason Promise or reason. + */ + private function invokeStats( + RequestInterface $request, + array $options, + ResponseInterface $response = null, + $reason = null + ): void { + if (isset($options['on_stats'])) { + $transferTime = $options['transfer_time'] ?? 0; + $stats = new TransferStats($request, $response, $transferTime, $reason); + ($options['on_stats'])($stats); + } + } +} diff --git a/lib/guzzlehttp/guzzle/src/Handler/Proxy.php b/lib/guzzlehttp/guzzle/src/Handler/Proxy.php new file mode 100644 index 00000000..f045b526 --- /dev/null +++ b/lib/guzzlehttp/guzzle/src/Handler/Proxy.php @@ -0,0 +1,51 @@ +withoutHeader('Expect'); + + // Append a content-length header if body size is zero to match + // cURL's behavior. + if (0 === $request->getBody()->getSize()) { + $request = $request->withHeader('Content-Length', '0'); + } + + return $this->createResponse( + $request, + $options, + $this->createStream($request, $options), + $startTime + ); + } catch (\InvalidArgumentException $e) { + throw $e; + } catch (\Exception $e) { + // Determine if the error was a networking error. + $message = $e->getMessage(); + // This list can probably get more comprehensive. + if (false !== \strpos($message, 'getaddrinfo') // DNS lookup failed + || false !== \strpos($message, 'Connection refused') + || false !== \strpos($message, "couldn't connect to host") // error on HHVM + || false !== \strpos($message, "connection attempt failed") + ) { + $e = new ConnectException($e->getMessage(), $request, $e); + } else { + $e = RequestException::wrapException($request, $e); + } + $this->invokeStats($options, $request, $startTime, null, $e); + + return P\Create::rejectionFor($e); + } + } + + private function invokeStats( + array $options, + RequestInterface $request, + ?float $startTime, + ResponseInterface $response = null, + \Throwable $error = null + ): void { + if (isset($options['on_stats'])) { + $stats = new TransferStats($request, $response, Utils::currentTime() - $startTime, $error, []); + ($options['on_stats'])($stats); + } + } + + /** + * @param resource $stream + */ + private function createResponse(RequestInterface $request, array $options, $stream, ?float $startTime): PromiseInterface + { + $hdrs = $this->lastHeaders; + $this->lastHeaders = []; + + try { + [$ver, $status, $reason, $headers] = HeaderProcessor::parseHeaders($hdrs); + } catch (\Exception $e) { + return P\Create::rejectionFor( + new RequestException('An error was encountered while creating the response', $request, null, $e) + ); + } + + [$stream, $headers] = $this->checkDecode($options, $headers, $stream); + $stream = Psr7\Utils::streamFor($stream); + $sink = $stream; + + if (\strcasecmp('HEAD', $request->getMethod())) { + $sink = $this->createSink($stream, $options); + } + + try { + $response = new Psr7\Response($status, $headers, $sink, $ver, $reason); + } catch (\Exception $e) { + return P\Create::rejectionFor( + new RequestException('An error was encountered while creating the response', $request, null, $e) + ); + } + + if (isset($options['on_headers'])) { + try { + $options['on_headers']($response); + } catch (\Exception $e) { + return P\Create::rejectionFor( + new RequestException('An error was encountered during the on_headers event', $request, $response, $e) + ); + } + } + + // Do not drain when the request is a HEAD request because they have + // no body. + if ($sink !== $stream) { + $this->drain($stream, $sink, $response->getHeaderLine('Content-Length')); + } + + $this->invokeStats($options, $request, $startTime, $response, null); + + return new FulfilledPromise($response); + } + + private function createSink(StreamInterface $stream, array $options): StreamInterface + { + if (!empty($options['stream'])) { + return $stream; + } + + $sink = $options['sink'] ?? Psr7\Utils::tryFopen('php://temp', 'r+'); + + return \is_string($sink) ? new Psr7\LazyOpenStream($sink, 'w+') : Psr7\Utils::streamFor($sink); + } + + /** + * @param resource $stream + */ + private function checkDecode(array $options, array $headers, $stream): array + { + // Automatically decode responses when instructed. + if (!empty($options['decode_content'])) { + $normalizedKeys = Utils::normalizeHeaderKeys($headers); + if (isset($normalizedKeys['content-encoding'])) { + $encoding = $headers[$normalizedKeys['content-encoding']]; + if ($encoding[0] === 'gzip' || $encoding[0] === 'deflate') { + $stream = new Psr7\InflateStream(Psr7\Utils::streamFor($stream)); + $headers['x-encoded-content-encoding'] = $headers[$normalizedKeys['content-encoding']]; + + // Remove content-encoding header + unset($headers[$normalizedKeys['content-encoding']]); + + // Fix content-length header + if (isset($normalizedKeys['content-length'])) { + $headers['x-encoded-content-length'] = $headers[$normalizedKeys['content-length']]; + $length = (int) $stream->getSize(); + if ($length === 0) { + unset($headers[$normalizedKeys['content-length']]); + } else { + $headers[$normalizedKeys['content-length']] = [$length]; + } + } + } + } + } + + return [$stream, $headers]; + } + + /** + * Drains the source stream into the "sink" client option. + * + * @param string $contentLength Header specifying the amount of + * data to read. + * + * @throws \RuntimeException when the sink option is invalid. + */ + private function drain(StreamInterface $source, StreamInterface $sink, string $contentLength): StreamInterface + { + // If a content-length header is provided, then stop reading once + // that number of bytes has been read. This can prevent infinitely + // reading from a stream when dealing with servers that do not honor + // Connection: Close headers. + Psr7\Utils::copyToStream( + $source, + $sink, + (\strlen($contentLength) > 0 && (int) $contentLength > 0) ? (int) $contentLength : -1 + ); + + $sink->seek(0); + $source->close(); + + return $sink; + } + + /** + * Create a resource and check to ensure it was created successfully + * + * @param callable $callback Callable that returns stream resource + * + * @return resource + * + * @throws \RuntimeException on error + */ + private function createResource(callable $callback) + { + $errors = []; + \set_error_handler(static function ($_, $msg, $file, $line) use (&$errors): bool { + $errors[] = [ + 'message' => $msg, + 'file' => $file, + 'line' => $line + ]; + return true; + }); + + try { + $resource = $callback(); + } finally { + \restore_error_handler(); + } + + if (!$resource) { + $message = 'Error creating resource: '; + foreach ($errors as $err) { + foreach ($err as $key => $value) { + $message .= "[$key] $value" . \PHP_EOL; + } + } + throw new \RuntimeException(\trim($message)); + } + + return $resource; + } + + /** + * @return resource + */ + private function createStream(RequestInterface $request, array $options) + { + static $methods; + if (!$methods) { + $methods = \array_flip(\get_class_methods(__CLASS__)); + } + + // HTTP/1.1 streams using the PHP stream wrapper require a + // Connection: close header + if ($request->getProtocolVersion() == '1.1' + && !$request->hasHeader('Connection') + ) { + $request = $request->withHeader('Connection', 'close'); + } + + // Ensure SSL is verified by default + if (!isset($options['verify'])) { + $options['verify'] = true; + } + + $params = []; + $context = $this->getDefaultContext($request); + + if (isset($options['on_headers']) && !\is_callable($options['on_headers'])) { + throw new \InvalidArgumentException('on_headers must be callable'); + } + + if (!empty($options)) { + foreach ($options as $key => $value) { + $method = "add_{$key}"; + if (isset($methods[$method])) { + $this->{$method}($request, $context, $value, $params); + } + } + } + + if (isset($options['stream_context'])) { + if (!\is_array($options['stream_context'])) { + throw new \InvalidArgumentException('stream_context must be an array'); + } + $context = \array_replace_recursive($context, $options['stream_context']); + } + + // Microsoft NTLM authentication only supported with curl handler + if (isset($options['auth'][2]) && 'ntlm' === $options['auth'][2]) { + throw new \InvalidArgumentException('Microsoft NTLM authentication only supported with curl handler'); + } + + $uri = $this->resolveHost($request, $options); + + $contextResource = $this->createResource( + static function () use ($context, $params) { + return \stream_context_create($context, $params); + } + ); + + return $this->createResource( + function () use ($uri, &$http_response_header, $contextResource, $context, $options, $request) { + $resource = @\fopen((string) $uri, 'r', false, $contextResource); + $this->lastHeaders = $http_response_header; + + if (false === $resource) { + throw new ConnectException(sprintf('Connection refused for URI %s', $uri), $request, null, $context); + } + + if (isset($options['read_timeout'])) { + $readTimeout = $options['read_timeout']; + $sec = (int) $readTimeout; + $usec = ($readTimeout - $sec) * 100000; + \stream_set_timeout($resource, $sec, $usec); + } + + return $resource; + } + ); + } + + private function resolveHost(RequestInterface $request, array $options): UriInterface + { + $uri = $request->getUri(); + + if (isset($options['force_ip_resolve']) && !\filter_var($uri->getHost(), \FILTER_VALIDATE_IP)) { + if ('v4' === $options['force_ip_resolve']) { + $records = \dns_get_record($uri->getHost(), \DNS_A); + if (false === $records || !isset($records[0]['ip'])) { + throw new ConnectException(\sprintf("Could not resolve IPv4 address for host '%s'", $uri->getHost()), $request); + } + return $uri->withHost($records[0]['ip']); + } + if ('v6' === $options['force_ip_resolve']) { + $records = \dns_get_record($uri->getHost(), \DNS_AAAA); + if (false === $records || !isset($records[0]['ipv6'])) { + throw new ConnectException(\sprintf("Could not resolve IPv6 address for host '%s'", $uri->getHost()), $request); + } + return $uri->withHost('[' . $records[0]['ipv6'] . ']'); + } + } + + return $uri; + } + + private function getDefaultContext(RequestInterface $request): array + { + $headers = ''; + foreach ($request->getHeaders() as $name => $value) { + foreach ($value as $val) { + $headers .= "$name: $val\r\n"; + } + } + + $context = [ + 'http' => [ + 'method' => $request->getMethod(), + 'header' => $headers, + 'protocol_version' => $request->getProtocolVersion(), + 'ignore_errors' => true, + 'follow_location' => 0, + ], + ]; + + $body = (string) $request->getBody(); + + if (!empty($body)) { + $context['http']['content'] = $body; + // Prevent the HTTP handler from adding a Content-Type header. + if (!$request->hasHeader('Content-Type')) { + $context['http']['header'] .= "Content-Type:\r\n"; + } + } + + $context['http']['header'] = \rtrim($context['http']['header']); + + return $context; + } + + /** + * @param mixed $value as passed via Request transfer options. + */ + private function add_proxy(RequestInterface $request, array &$options, $value, array &$params): void + { + $uri = null; + + if (!\is_array($value)) { + $uri = $value; + } else { + $scheme = $request->getUri()->getScheme(); + if (isset($value[$scheme])) { + if (!isset($value['no']) || !Utils::isHostInNoProxy($request->getUri()->getHost(), $value['no'])) { + $uri = $value[$scheme]; + } + } + } + + if (!$uri) { + return; + } + + $parsed = $this->parse_proxy($uri); + $options['http']['proxy'] = $parsed['proxy']; + + if ($parsed['auth']) { + if (!isset($options['http']['header'])) { + $options['http']['header'] = []; + } + $options['http']['header'] .= "\r\nProxy-Authorization: {$parsed['auth']}"; + } + } + + /** + * Parses the given proxy URL to make it compatible with the format PHP's stream context expects. + */ + private function parse_proxy(string $url): array + { + $parsed = \parse_url($url); + + if ($parsed !== false && isset($parsed['scheme']) && $parsed['scheme'] === 'http') { + if (isset($parsed['host']) && isset($parsed['port'])) { + $auth = null; + if (isset($parsed['user']) && isset($parsed['pass'])) { + $auth = \base64_encode("{$parsed['user']}:{$parsed['pass']}"); + } + + return [ + 'proxy' => "tcp://{$parsed['host']}:{$parsed['port']}", + 'auth' => $auth ? "Basic {$auth}" : null, + ]; + } + } + + // Return proxy as-is. + return [ + 'proxy' => $url, + 'auth' => null, + ]; + } + + /** + * @param mixed $value as passed via Request transfer options. + */ + private function add_timeout(RequestInterface $request, array &$options, $value, array &$params): void + { + if ($value > 0) { + $options['http']['timeout'] = $value; + } + } + + /** + * @param mixed $value as passed via Request transfer options. + */ + private function add_verify(RequestInterface $request, array &$options, $value, array &$params): void + { + if ($value === false) { + $options['ssl']['verify_peer'] = false; + $options['ssl']['verify_peer_name'] = false; + + return; + } + + if (\is_string($value)) { + $options['ssl']['cafile'] = $value; + if (!\file_exists($value)) { + throw new \RuntimeException("SSL CA bundle not found: $value"); + } + } elseif ($value !== true) { + throw new \InvalidArgumentException('Invalid verify request option'); + } + + $options['ssl']['verify_peer'] = true; + $options['ssl']['verify_peer_name'] = true; + $options['ssl']['allow_self_signed'] = false; + } + + /** + * @param mixed $value as passed via Request transfer options. + */ + private function add_cert(RequestInterface $request, array &$options, $value, array &$params): void + { + if (\is_array($value)) { + $options['ssl']['passphrase'] = $value[1]; + $value = $value[0]; + } + + if (!\file_exists($value)) { + throw new \RuntimeException("SSL certificate not found: {$value}"); + } + + $options['ssl']['local_cert'] = $value; + } + + /** + * @param mixed $value as passed via Request transfer options. + */ + private function add_progress(RequestInterface $request, array &$options, $value, array &$params): void + { + self::addNotification( + $params, + static function ($code, $a, $b, $c, $transferred, $total) use ($value) { + if ($code == \STREAM_NOTIFY_PROGRESS) { + // The upload progress cannot be determined. Use 0 for cURL compatibility: + // https://curl.se/libcurl/c/CURLOPT_PROGRESSFUNCTION.html + $value($total, $transferred, 0, 0); + } + } + ); + } + + /** + * @param mixed $value as passed via Request transfer options. + */ + private function add_debug(RequestInterface $request, array &$options, $value, array &$params): void + { + if ($value === false) { + return; + } + + static $map = [ + \STREAM_NOTIFY_CONNECT => 'CONNECT', + \STREAM_NOTIFY_AUTH_REQUIRED => 'AUTH_REQUIRED', + \STREAM_NOTIFY_AUTH_RESULT => 'AUTH_RESULT', + \STREAM_NOTIFY_MIME_TYPE_IS => 'MIME_TYPE_IS', + \STREAM_NOTIFY_FILE_SIZE_IS => 'FILE_SIZE_IS', + \STREAM_NOTIFY_REDIRECTED => 'REDIRECTED', + \STREAM_NOTIFY_PROGRESS => 'PROGRESS', + \STREAM_NOTIFY_FAILURE => 'FAILURE', + \STREAM_NOTIFY_COMPLETED => 'COMPLETED', + \STREAM_NOTIFY_RESOLVE => 'RESOLVE', + ]; + static $args = ['severity', 'message', 'message_code', 'bytes_transferred', 'bytes_max']; + + $value = Utils::debugResource($value); + $ident = $request->getMethod() . ' ' . $request->getUri()->withFragment(''); + self::addNotification( + $params, + static function (int $code, ...$passed) use ($ident, $value, $map, $args): void { + \fprintf($value, '<%s> [%s] ', $ident, $map[$code]); + foreach (\array_filter($passed) as $i => $v) { + \fwrite($value, $args[$i] . ': "' . $v . '" '); + } + \fwrite($value, "\n"); + } + ); + } + + private static function addNotification(array &$params, callable $notify): void + { + // Wrap the existing function if needed. + if (!isset($params['notification'])) { + $params['notification'] = $notify; + } else { + $params['notification'] = self::callArray([ + $params['notification'], + $notify + ]); + } + } + + private static function callArray(array $functions): callable + { + return static function (...$args) use ($functions) { + foreach ($functions as $fn) { + $fn(...$args); + } + }; + } +} diff --git a/lib/guzzlehttp/guzzle/src/HandlerStack.php b/lib/guzzlehttp/guzzle/src/HandlerStack.php new file mode 100644 index 00000000..e0a1d119 --- /dev/null +++ b/lib/guzzlehttp/guzzle/src/HandlerStack.php @@ -0,0 +1,275 @@ +push(Middleware::httpErrors(), 'http_errors'); + $stack->push(Middleware::redirect(), 'allow_redirects'); + $stack->push(Middleware::cookies(), 'cookies'); + $stack->push(Middleware::prepareBody(), 'prepare_body'); + + return $stack; + } + + /** + * @param (callable(RequestInterface, array): PromiseInterface)|null $handler Underlying HTTP handler. + */ + public function __construct(callable $handler = null) + { + $this->handler = $handler; + } + + /** + * Invokes the handler stack as a composed handler + * + * @return ResponseInterface|PromiseInterface + */ + public function __invoke(RequestInterface $request, array $options) + { + $handler = $this->resolve(); + + return $handler($request, $options); + } + + /** + * Dumps a string representation of the stack. + * + * @return string + */ + public function __toString() + { + $depth = 0; + $stack = []; + + if ($this->handler !== null) { + $stack[] = "0) Handler: " . $this->debugCallable($this->handler); + } + + $result = ''; + foreach (\array_reverse($this->stack) as $tuple) { + $depth++; + $str = "{$depth}) Name: '{$tuple[1]}', "; + $str .= "Function: " . $this->debugCallable($tuple[0]); + $result = "> {$str}\n{$result}"; + $stack[] = $str; + } + + foreach (\array_keys($stack) as $k) { + $result .= "< {$stack[$k]}\n"; + } + + return $result; + } + + /** + * Set the HTTP handler that actually returns a promise. + * + * @param callable(RequestInterface, array): PromiseInterface $handler Accepts a request and array of options and + * returns a Promise. + */ + public function setHandler(callable $handler): void + { + $this->handler = $handler; + $this->cached = null; + } + + /** + * Returns true if the builder has a handler. + */ + public function hasHandler(): bool + { + return $this->handler !== null ; + } + + /** + * Unshift a middleware to the bottom of the stack. + * + * @param callable(callable): callable $middleware Middleware function + * @param string $name Name to register for this middleware. + */ + public function unshift(callable $middleware, ?string $name = null): void + { + \array_unshift($this->stack, [$middleware, $name]); + $this->cached = null; + } + + /** + * Push a middleware to the top of the stack. + * + * @param callable(callable): callable $middleware Middleware function + * @param string $name Name to register for this middleware. + */ + public function push(callable $middleware, string $name = ''): void + { + $this->stack[] = [$middleware, $name]; + $this->cached = null; + } + + /** + * Add a middleware before another middleware by name. + * + * @param string $findName Middleware to find + * @param callable(callable): callable $middleware Middleware function + * @param string $withName Name to register for this middleware. + */ + public function before(string $findName, callable $middleware, string $withName = ''): void + { + $this->splice($findName, $withName, $middleware, true); + } + + /** + * Add a middleware after another middleware by name. + * + * @param string $findName Middleware to find + * @param callable(callable): callable $middleware Middleware function + * @param string $withName Name to register for this middleware. + */ + public function after(string $findName, callable $middleware, string $withName = ''): void + { + $this->splice($findName, $withName, $middleware, false); + } + + /** + * Remove a middleware by instance or name from the stack. + * + * @param callable|string $remove Middleware to remove by instance or name. + */ + public function remove($remove): void + { + if (!is_string($remove) && !is_callable($remove)) { + trigger_deprecation('guzzlehttp/guzzle', '7.4', 'Not passing a callable or string to %s::%s() is deprecated and will cause an error in 8.0.', __CLASS__, __FUNCTION__); + } + + $this->cached = null; + $idx = \is_callable($remove) ? 0 : 1; + $this->stack = \array_values(\array_filter( + $this->stack, + static function ($tuple) use ($idx, $remove) { + return $tuple[$idx] !== $remove; + } + )); + } + + /** + * Compose the middleware and handler into a single callable function. + * + * @return callable(RequestInterface, array): PromiseInterface + */ + public function resolve(): callable + { + if ($this->cached === null) { + if (($prev = $this->handler) === null) { + throw new \LogicException('No handler has been specified'); + } + + foreach (\array_reverse($this->stack) as $fn) { + /** @var callable(RequestInterface, array): PromiseInterface $prev */ + $prev = $fn[0]($prev); + } + + $this->cached = $prev; + } + + return $this->cached; + } + + private function findByName(string $name): int + { + foreach ($this->stack as $k => $v) { + if ($v[1] === $name) { + return $k; + } + } + + throw new \InvalidArgumentException("Middleware not found: $name"); + } + + /** + * Splices a function into the middleware list at a specific position. + */ + private function splice(string $findName, string $withName, callable $middleware, bool $before): void + { + $this->cached = null; + $idx = $this->findByName($findName); + $tuple = [$middleware, $withName]; + + if ($before) { + if ($idx === 0) { + \array_unshift($this->stack, $tuple); + } else { + $replacement = [$tuple, $this->stack[$idx]]; + \array_splice($this->stack, $idx, 1, $replacement); + } + } elseif ($idx === \count($this->stack) - 1) { + $this->stack[] = $tuple; + } else { + $replacement = [$this->stack[$idx], $tuple]; + \array_splice($this->stack, $idx, 1, $replacement); + } + } + + /** + * Provides a debug string for a given callable. + * + * @param callable|string $fn Function to write as a string. + */ + private function debugCallable($fn): string + { + if (\is_string($fn)) { + return "callable({$fn})"; + } + + if (\is_array($fn)) { + return \is_string($fn[0]) + ? "callable({$fn[0]}::{$fn[1]})" + : "callable(['" . \get_class($fn[0]) . "', '{$fn[1]}'])"; + } + + /** @var object $fn */ + return 'callable(' . \spl_object_hash($fn) . ')'; + } +} diff --git a/lib/guzzlehttp/guzzle/src/MessageFormatter.php b/lib/guzzlehttp/guzzle/src/MessageFormatter.php new file mode 100644 index 00000000..238770f8 --- /dev/null +++ b/lib/guzzlehttp/guzzle/src/MessageFormatter.php @@ -0,0 +1,198 @@ +>>>>>>>\n{request}\n<<<<<<<<\n{response}\n--------\n{error}"; + public const SHORT = '[{ts}] "{method} {target} HTTP/{version}" {code}'; + + /** + * @var string Template used to format log messages + */ + private $template; + + /** + * @param string $template Log message template + */ + public function __construct(?string $template = self::CLF) + { + $this->template = $template ?: self::CLF; + } + + /** + * Returns a formatted message string. + * + * @param RequestInterface $request Request that was sent + * @param ResponseInterface|null $response Response that was received + * @param \Throwable|null $error Exception that was received + */ + public function format(RequestInterface $request, ?ResponseInterface $response = null, ?\Throwable $error = null): string + { + $cache = []; + + /** @var string */ + return \preg_replace_callback( + '/{\s*([A-Za-z_\-\.0-9]+)\s*}/', + function (array $matches) use ($request, $response, $error, &$cache) { + if (isset($cache[$matches[1]])) { + return $cache[$matches[1]]; + } + + $result = ''; + switch ($matches[1]) { + case 'request': + $result = Psr7\Message::toString($request); + break; + case 'response': + $result = $response ? Psr7\Message::toString($response) : ''; + break; + case 'req_headers': + $result = \trim($request->getMethod() + . ' ' . $request->getRequestTarget()) + . ' HTTP/' . $request->getProtocolVersion() . "\r\n" + . $this->headers($request); + break; + case 'res_headers': + $result = $response ? + \sprintf( + 'HTTP/%s %d %s', + $response->getProtocolVersion(), + $response->getStatusCode(), + $response->getReasonPhrase() + ) . "\r\n" . $this->headers($response) + : 'NULL'; + break; + case 'req_body': + $result = $request->getBody()->__toString(); + break; + case 'res_body': + if (!$response instanceof ResponseInterface) { + $result = 'NULL'; + break; + } + + $body = $response->getBody(); + + if (!$body->isSeekable()) { + $result = 'RESPONSE_NOT_LOGGEABLE'; + break; + } + + $result = $response->getBody()->__toString(); + break; + case 'ts': + case 'date_iso_8601': + $result = \gmdate('c'); + break; + case 'date_common_log': + $result = \date('d/M/Y:H:i:s O'); + break; + case 'method': + $result = $request->getMethod(); + break; + case 'version': + $result = $request->getProtocolVersion(); + break; + case 'uri': + case 'url': + $result = $request->getUri(); + break; + case 'target': + $result = $request->getRequestTarget(); + break; + case 'req_version': + $result = $request->getProtocolVersion(); + break; + case 'res_version': + $result = $response + ? $response->getProtocolVersion() + : 'NULL'; + break; + case 'host': + $result = $request->getHeaderLine('Host'); + break; + case 'hostname': + $result = \gethostname(); + break; + case 'code': + $result = $response ? $response->getStatusCode() : 'NULL'; + break; + case 'phrase': + $result = $response ? $response->getReasonPhrase() : 'NULL'; + break; + case 'error': + $result = $error ? $error->getMessage() : 'NULL'; + break; + default: + // handle prefixed dynamic headers + if (\strpos($matches[1], 'req_header_') === 0) { + $result = $request->getHeaderLine(\substr($matches[1], 11)); + } elseif (\strpos($matches[1], 'res_header_') === 0) { + $result = $response + ? $response->getHeaderLine(\substr($matches[1], 11)) + : 'NULL'; + } + } + + $cache[$matches[1]] = $result; + return $result; + }, + $this->template + ); + } + + /** + * Get headers from message as string + */ + private function headers(MessageInterface $message): string + { + $result = ''; + foreach ($message->getHeaders() as $name => $values) { + $result .= $name . ': ' . \implode(', ', $values) . "\r\n"; + } + + return \trim($result); + } +} diff --git a/lib/guzzlehttp/guzzle/src/MessageFormatterInterface.php b/lib/guzzlehttp/guzzle/src/MessageFormatterInterface.php new file mode 100644 index 00000000..a39ac248 --- /dev/null +++ b/lib/guzzlehttp/guzzle/src/MessageFormatterInterface.php @@ -0,0 +1,18 @@ +withCookieHeader($request); + return $handler($request, $options) + ->then( + static function (ResponseInterface $response) use ($cookieJar, $request): ResponseInterface { + $cookieJar->extractCookies($request, $response); + return $response; + } + ); + }; + }; + } + + /** + * Middleware that throws exceptions for 4xx or 5xx responses when the + * "http_errors" request option is set to true. + * + * @param BodySummarizerInterface|null $bodySummarizer The body summarizer to use in exception messages. + * + * @return callable(callable): callable Returns a function that accepts the next handler. + */ + public static function httpErrors(BodySummarizerInterface $bodySummarizer = null): callable + { + return static function (callable $handler) use ($bodySummarizer): callable { + return static function ($request, array $options) use ($handler, $bodySummarizer) { + if (empty($options['http_errors'])) { + return $handler($request, $options); + } + return $handler($request, $options)->then( + static function (ResponseInterface $response) use ($request, $bodySummarizer) { + $code = $response->getStatusCode(); + if ($code < 400) { + return $response; + } + throw RequestException::create($request, $response, null, [], $bodySummarizer); + } + ); + }; + }; + } + + /** + * Middleware that pushes history data to an ArrayAccess container. + * + * @param array|\ArrayAccess $container Container to hold the history (by reference). + * + * @return callable(callable): callable Returns a function that accepts the next handler. + * + * @throws \InvalidArgumentException if container is not an array or ArrayAccess. + */ + public static function history(&$container): callable + { + if (!\is_array($container) && !$container instanceof \ArrayAccess) { + throw new \InvalidArgumentException('history container must be an array or object implementing ArrayAccess'); + } + + return static function (callable $handler) use (&$container): callable { + return static function (RequestInterface $request, array $options) use ($handler, &$container) { + return $handler($request, $options)->then( + static function ($value) use ($request, &$container, $options) { + $container[] = [ + 'request' => $request, + 'response' => $value, + 'error' => null, + 'options' => $options + ]; + return $value; + }, + static function ($reason) use ($request, &$container, $options) { + $container[] = [ + 'request' => $request, + 'response' => null, + 'error' => $reason, + 'options' => $options + ]; + return P\Create::rejectionFor($reason); + } + ); + }; + }; + } + + /** + * Middleware that invokes a callback before and after sending a request. + * + * The provided listener cannot modify or alter the response. It simply + * "taps" into the chain to be notified before returning the promise. The + * before listener accepts a request and options array, and the after + * listener accepts a request, options array, and response promise. + * + * @param callable $before Function to invoke before forwarding the request. + * @param callable $after Function invoked after forwarding. + * + * @return callable Returns a function that accepts the next handler. + */ + public static function tap(callable $before = null, callable $after = null): callable + { + return static function (callable $handler) use ($before, $after): callable { + return static function (RequestInterface $request, array $options) use ($handler, $before, $after) { + if ($before) { + $before($request, $options); + } + $response = $handler($request, $options); + if ($after) { + $after($request, $options, $response); + } + return $response; + }; + }; + } + + /** + * Middleware that handles request redirects. + * + * @return callable Returns a function that accepts the next handler. + */ + public static function redirect(): callable + { + return static function (callable $handler): RedirectMiddleware { + return new RedirectMiddleware($handler); + }; + } + + /** + * Middleware that retries requests based on the boolean result of + * invoking the provided "decider" function. + * + * If no delay function is provided, a simple implementation of exponential + * backoff will be utilized. + * + * @param callable $decider Function that accepts the number of retries, + * a request, [response], and [exception] and + * returns true if the request is to be retried. + * @param callable $delay Function that accepts the number of retries and + * returns the number of milliseconds to delay. + * + * @return callable Returns a function that accepts the next handler. + */ + public static function retry(callable $decider, callable $delay = null): callable + { + return static function (callable $handler) use ($decider, $delay): RetryMiddleware { + return new RetryMiddleware($decider, $handler, $delay); + }; + } + + /** + * Middleware that logs requests, responses, and errors using a message + * formatter. + * + * @phpstan-param \Psr\Log\LogLevel::* $logLevel Level at which to log requests. + * + * @param LoggerInterface $logger Logs messages. + * @param MessageFormatterInterface|MessageFormatter $formatter Formatter used to create message strings. + * @param string $logLevel Level at which to log requests. + * + * @return callable Returns a function that accepts the next handler. + */ + public static function log(LoggerInterface $logger, $formatter, string $logLevel = 'info'): callable + { + // To be compatible with Guzzle 7.1.x we need to allow users to pass a MessageFormatter + if (!$formatter instanceof MessageFormatter && !$formatter instanceof MessageFormatterInterface) { + throw new \LogicException(sprintf('Argument 2 to %s::log() must be of type %s', self::class, MessageFormatterInterface::class)); + } + + return static function (callable $handler) use ($logger, $formatter, $logLevel): callable { + return static function (RequestInterface $request, array $options = []) use ($handler, $logger, $formatter, $logLevel) { + return $handler($request, $options)->then( + static function ($response) use ($logger, $request, $formatter, $logLevel): ResponseInterface { + $message = $formatter->format($request, $response); + $logger->log($logLevel, $message); + return $response; + }, + static function ($reason) use ($logger, $request, $formatter): PromiseInterface { + $response = $reason instanceof RequestException ? $reason->getResponse() : null; + $message = $formatter->format($request, $response, P\Create::exceptionFor($reason)); + $logger->error($message); + return P\Create::rejectionFor($reason); + } + ); + }; + }; + } + + /** + * This middleware adds a default content-type if possible, a default + * content-length or transfer-encoding header, and the expect header. + */ + public static function prepareBody(): callable + { + return static function (callable $handler): PrepareBodyMiddleware { + return new PrepareBodyMiddleware($handler); + }; + } + + /** + * Middleware that applies a map function to the request before passing to + * the next handler. + * + * @param callable $fn Function that accepts a RequestInterface and returns + * a RequestInterface. + */ + public static function mapRequest(callable $fn): callable + { + return static function (callable $handler) use ($fn): callable { + return static function (RequestInterface $request, array $options) use ($handler, $fn) { + return $handler($fn($request), $options); + }; + }; + } + + /** + * Middleware that applies a map function to the resolved promise's + * response. + * + * @param callable $fn Function that accepts a ResponseInterface and + * returns a ResponseInterface. + */ + public static function mapResponse(callable $fn): callable + { + return static function (callable $handler) use ($fn): callable { + return static function (RequestInterface $request, array $options) use ($handler, $fn) { + return $handler($request, $options)->then($fn); + }; + }; + } +} diff --git a/lib/guzzlehttp/guzzle/src/Pool.php b/lib/guzzlehttp/guzzle/src/Pool.php new file mode 100644 index 00000000..6277c61f --- /dev/null +++ b/lib/guzzlehttp/guzzle/src/Pool.php @@ -0,0 +1,125 @@ + $rfn) { + if ($rfn instanceof RequestInterface) { + yield $key => $client->sendAsync($rfn, $opts); + } elseif (\is_callable($rfn)) { + yield $key => $rfn($opts); + } else { + throw new \InvalidArgumentException('Each value yielded by the iterator must be a Psr7\Http\Message\RequestInterface or a callable that returns a promise that fulfills with a Psr7\Message\Http\ResponseInterface object.'); + } + } + }; + + $this->each = new EachPromise($requests(), $config); + } + + /** + * Get promise + */ + public function promise(): PromiseInterface + { + return $this->each->promise(); + } + + /** + * Sends multiple requests concurrently and returns an array of responses + * and exceptions that uses the same ordering as the provided requests. + * + * IMPORTANT: This method keeps every request and response in memory, and + * as such, is NOT recommended when sending a large number or an + * indeterminate number of requests concurrently. + * + * @param ClientInterface $client Client used to send the requests + * @param array|\Iterator $requests Requests to send concurrently. + * @param array $options Passes through the options available in + * {@see \GuzzleHttp\Pool::__construct} + * + * @return array Returns an array containing the response or an exception + * in the same order that the requests were sent. + * + * @throws \InvalidArgumentException if the event format is incorrect. + */ + public static function batch(ClientInterface $client, $requests, array $options = []): array + { + $res = []; + self::cmpCallback($options, 'fulfilled', $res); + self::cmpCallback($options, 'rejected', $res); + $pool = new static($client, $requests, $options); + $pool->promise()->wait(); + \ksort($res); + + return $res; + } + + /** + * Execute callback(s) + */ + private static function cmpCallback(array &$options, string $name, array &$results): void + { + if (!isset($options[$name])) { + $options[$name] = static function ($v, $k) use (&$results) { + $results[$k] = $v; + }; + } else { + $currentFn = $options[$name]; + $options[$name] = static function ($v, $k) use (&$results, $currentFn) { + $currentFn($v, $k); + $results[$k] = $v; + }; + } + } +} diff --git a/lib/guzzlehttp/guzzle/src/PrepareBodyMiddleware.php b/lib/guzzlehttp/guzzle/src/PrepareBodyMiddleware.php new file mode 100644 index 00000000..7ca62833 --- /dev/null +++ b/lib/guzzlehttp/guzzle/src/PrepareBodyMiddleware.php @@ -0,0 +1,104 @@ +nextHandler = $nextHandler; + } + + public function __invoke(RequestInterface $request, array $options): PromiseInterface + { + $fn = $this->nextHandler; + + // Don't do anything if the request has no body. + if ($request->getBody()->getSize() === 0) { + return $fn($request, $options); + } + + $modify = []; + + // Add a default content-type if possible. + if (!$request->hasHeader('Content-Type')) { + if ($uri = $request->getBody()->getMetadata('uri')) { + if (is_string($uri) && $type = Psr7\MimeType::fromFilename($uri)) { + $modify['set_headers']['Content-Type'] = $type; + } + } + } + + // Add a default content-length or transfer-encoding header. + if (!$request->hasHeader('Content-Length') + && !$request->hasHeader('Transfer-Encoding') + ) { + $size = $request->getBody()->getSize(); + if ($size !== null) { + $modify['set_headers']['Content-Length'] = $size; + } else { + $modify['set_headers']['Transfer-Encoding'] = 'chunked'; + } + } + + // Add the expect header if needed. + $this->addExpectHeader($request, $options, $modify); + + return $fn(Psr7\Utils::modifyRequest($request, $modify), $options); + } + + /** + * Add expect header + */ + private function addExpectHeader(RequestInterface $request, array $options, array &$modify): void + { + // Determine if the Expect header should be used + if ($request->hasHeader('Expect')) { + return; + } + + $expect = $options['expect'] ?? null; + + // Return if disabled or if you're not using HTTP/1.1 or HTTP/2.0 + if ($expect === false || $request->getProtocolVersion() < 1.1) { + return; + } + + // The expect header is unconditionally enabled + if ($expect === true) { + $modify['set_headers']['Expect'] = '100-Continue'; + return; + } + + // By default, send the expect header when the payload is > 1mb + if ($expect === null) { + $expect = 1048576; + } + + // Always add if the body cannot be rewound, the size cannot be + // determined, or the size is greater than the cutoff threshold + $body = $request->getBody(); + $size = $body->getSize(); + + if ($size === null || $size >= (int) $expect || !$body->isSeekable()) { + $modify['set_headers']['Expect'] = '100-Continue'; + } + } +} diff --git a/lib/guzzlehttp/guzzle/src/RedirectMiddleware.php b/lib/guzzlehttp/guzzle/src/RedirectMiddleware.php new file mode 100644 index 00000000..1dd38614 --- /dev/null +++ b/lib/guzzlehttp/guzzle/src/RedirectMiddleware.php @@ -0,0 +1,216 @@ + 5, + 'protocols' => ['http', 'https'], + 'strict' => false, + 'referer' => false, + 'track_redirects' => false, + ]; + + /** + * @var callable(RequestInterface, array): PromiseInterface + */ + private $nextHandler; + + /** + * @param callable(RequestInterface, array): PromiseInterface $nextHandler Next handler to invoke. + */ + public function __construct(callable $nextHandler) + { + $this->nextHandler = $nextHandler; + } + + public function __invoke(RequestInterface $request, array $options): PromiseInterface + { + $fn = $this->nextHandler; + + if (empty($options['allow_redirects'])) { + return $fn($request, $options); + } + + if ($options['allow_redirects'] === true) { + $options['allow_redirects'] = self::$defaultSettings; + } elseif (!\is_array($options['allow_redirects'])) { + throw new \InvalidArgumentException('allow_redirects must be true, false, or array'); + } else { + // Merge the default settings with the provided settings + $options['allow_redirects'] += self::$defaultSettings; + } + + if (empty($options['allow_redirects']['max'])) { + return $fn($request, $options); + } + + return $fn($request, $options) + ->then(function (ResponseInterface $response) use ($request, $options) { + return $this->checkRedirect($request, $options, $response); + }); + } + + /** + * @return ResponseInterface|PromiseInterface + */ + public function checkRedirect(RequestInterface $request, array $options, ResponseInterface $response) + { + if (\strpos((string) $response->getStatusCode(), '3') !== 0 + || !$response->hasHeader('Location') + ) { + return $response; + } + + $this->guardMax($request, $response, $options); + $nextRequest = $this->modifyRequest($request, $options, $response); + + if (isset($options['allow_redirects']['on_redirect'])) { + ($options['allow_redirects']['on_redirect'])( + $request, + $response, + $nextRequest->getUri() + ); + } + + $promise = $this($nextRequest, $options); + + // Add headers to be able to track history of redirects. + if (!empty($options['allow_redirects']['track_redirects'])) { + return $this->withTracking( + $promise, + (string) $nextRequest->getUri(), + $response->getStatusCode() + ); + } + + return $promise; + } + + /** + * Enable tracking on promise. + */ + private function withTracking(PromiseInterface $promise, string $uri, int $statusCode): PromiseInterface + { + return $promise->then( + static function (ResponseInterface $response) use ($uri, $statusCode) { + // Note that we are pushing to the front of the list as this + // would be an earlier response than what is currently present + // in the history header. + $historyHeader = $response->getHeader(self::HISTORY_HEADER); + $statusHeader = $response->getHeader(self::STATUS_HISTORY_HEADER); + \array_unshift($historyHeader, $uri); + \array_unshift($statusHeader, (string) $statusCode); + + return $response->withHeader(self::HISTORY_HEADER, $historyHeader) + ->withHeader(self::STATUS_HISTORY_HEADER, $statusHeader); + } + ); + } + + /** + * Check for too many redirects + * + * @throws TooManyRedirectsException Too many redirects. + */ + private function guardMax(RequestInterface $request, ResponseInterface $response, array &$options): void + { + $current = $options['__redirect_count'] + ?? 0; + $options['__redirect_count'] = $current + 1; + $max = $options['allow_redirects']['max']; + + if ($options['__redirect_count'] > $max) { + throw new TooManyRedirectsException("Will not follow more than {$max} redirects", $request, $response); + } + } + + public function modifyRequest(RequestInterface $request, array $options, ResponseInterface $response): RequestInterface + { + // Request modifications to apply. + $modify = []; + $protocols = $options['allow_redirects']['protocols']; + + // Use a GET request if this is an entity enclosing request and we are + // not forcing RFC compliance, but rather emulating what all browsers + // would do. + $statusCode = $response->getStatusCode(); + if ($statusCode == 303 || + ($statusCode <= 302 && !$options['allow_redirects']['strict']) + ) { + $safeMethods = ['GET', 'HEAD', 'OPTIONS']; + $requestMethod = $request->getMethod(); + + $modify['method'] = in_array($requestMethod, $safeMethods) ? $requestMethod : 'GET'; + $modify['body'] = ''; + } + + $uri = $this->redirectUri($request, $response, $protocols); + if (isset($options['idn_conversion']) && ($options['idn_conversion'] !== false)) { + $idnOptions = ($options['idn_conversion'] === true) ? \IDNA_DEFAULT : $options['idn_conversion']; + $uri = Utils::idnUriConvert($uri, $idnOptions); + } + + $modify['uri'] = $uri; + Psr7\Message::rewindBody($request); + + // Add the Referer header if it is told to do so and only + // add the header if we are not redirecting from https to http. + if ($options['allow_redirects']['referer'] + && $modify['uri']->getScheme() === $request->getUri()->getScheme() + ) { + $uri = $request->getUri()->withUserInfo(''); + $modify['set_headers']['Referer'] = (string) $uri; + } else { + $modify['remove_headers'][] = 'Referer'; + } + + // Remove Authorization header if host is different. + if ($request->getUri()->getHost() !== $modify['uri']->getHost()) { + $modify['remove_headers'][] = 'Authorization'; + } + + return Psr7\Utils::modifyRequest($request, $modify); + } + + /** + * Set the appropriate URL on the request based on the location header + */ + private function redirectUri(RequestInterface $request, ResponseInterface $response, array $protocols): UriInterface + { + $location = Psr7\UriResolver::resolve( + $request->getUri(), + new Psr7\Uri($response->getHeaderLine('Location')) + ); + + // Ensure that the redirect URI is allowed based on the protocols. + if (!\in_array($location->getScheme(), $protocols)) { + throw new BadResponseException(\sprintf('Redirect URI, %s, does not use one of the allowed redirect protocols: %s', $location, \implode(', ', $protocols)), $request, $response); + } + + return $location; + } +} diff --git a/lib/guzzlehttp/guzzle/src/RequestOptions.php b/lib/guzzlehttp/guzzle/src/RequestOptions.php new file mode 100644 index 00000000..20b31bc2 --- /dev/null +++ b/lib/guzzlehttp/guzzle/src/RequestOptions.php @@ -0,0 +1,264 @@ +decider = $decider; + $this->nextHandler = $nextHandler; + $this->delay = $delay ?: __CLASS__ . '::exponentialDelay'; + } + + /** + * Default exponential backoff delay function. + * + * @return int milliseconds. + */ + public static function exponentialDelay(int $retries): int + { + return (int) \pow(2, $retries - 1) * 1000; + } + + public function __invoke(RequestInterface $request, array $options): PromiseInterface + { + if (!isset($options['retries'])) { + $options['retries'] = 0; + } + + $fn = $this->nextHandler; + return $fn($request, $options) + ->then( + $this->onFulfilled($request, $options), + $this->onRejected($request, $options) + ); + } + + /** + * Execute fulfilled closure + */ + private function onFulfilled(RequestInterface $request, array $options): callable + { + return function ($value) use ($request, $options) { + if (!($this->decider)( + $options['retries'], + $request, + $value, + null + )) { + return $value; + } + return $this->doRetry($request, $options, $value); + }; + } + + /** + * Execute rejected closure + */ + private function onRejected(RequestInterface $req, array $options): callable + { + return function ($reason) use ($req, $options) { + if (!($this->decider)( + $options['retries'], + $req, + null, + $reason + )) { + return P\Create::rejectionFor($reason); + } + return $this->doRetry($req, $options); + }; + } + + private function doRetry(RequestInterface $request, array $options, ResponseInterface $response = null): PromiseInterface + { + $options['delay'] = ($this->delay)(++$options['retries'], $response); + + return $this($request, $options); + } +} diff --git a/lib/guzzlehttp/guzzle/src/TransferStats.php b/lib/guzzlehttp/guzzle/src/TransferStats.php new file mode 100644 index 00000000..93fa334c --- /dev/null +++ b/lib/guzzlehttp/guzzle/src/TransferStats.php @@ -0,0 +1,133 @@ +request = $request; + $this->response = $response; + $this->transferTime = $transferTime; + $this->handlerErrorData = $handlerErrorData; + $this->handlerStats = $handlerStats; + } + + public function getRequest(): RequestInterface + { + return $this->request; + } + + /** + * Returns the response that was received (if any). + */ + public function getResponse(): ?ResponseInterface + { + return $this->response; + } + + /** + * Returns true if a response was received. + */ + public function hasResponse(): bool + { + return $this->response !== null; + } + + /** + * Gets handler specific error data. + * + * This might be an exception, a integer representing an error code, or + * anything else. Relying on this value assumes that you know what handler + * you are using. + * + * @return mixed + */ + public function getHandlerErrorData() + { + return $this->handlerErrorData; + } + + /** + * Get the effective URI the request was sent to. + */ + public function getEffectiveUri(): UriInterface + { + return $this->request->getUri(); + } + + /** + * Get the estimated time the request was being transferred by the handler. + * + * @return float|null Time in seconds. + */ + public function getTransferTime(): ?float + { + return $this->transferTime; + } + + /** + * Gets an array of all of the handler specific transfer data. + */ + public function getHandlerStats(): array + { + return $this->handlerStats; + } + + /** + * Get a specific handler statistic from the handler by name. + * + * @param string $stat Handler specific transfer stat to retrieve. + * + * @return mixed|null + */ + public function getHandlerStat(string $stat) + { + return $this->handlerStats[$stat] ?? null; + } +} diff --git a/lib/guzzlehttp/guzzle/src/Utils.php b/lib/guzzlehttp/guzzle/src/Utils.php new file mode 100644 index 00000000..91591da2 --- /dev/null +++ b/lib/guzzlehttp/guzzle/src/Utils.php @@ -0,0 +1,382 @@ +getHost()) { + $asciiHost = self::idnToAsci($uri->getHost(), $options, $info); + if ($asciiHost === false) { + $errorBitSet = $info['errors'] ?? 0; + + $errorConstants = array_filter(array_keys(get_defined_constants()), static function (string $name): bool { + return substr($name, 0, 11) === 'IDNA_ERROR_'; + }); + + $errors = []; + foreach ($errorConstants as $errorConstant) { + if ($errorBitSet & constant($errorConstant)) { + $errors[] = $errorConstant; + } + } + + $errorMessage = 'IDN conversion failed'; + if ($errors) { + $errorMessage .= ' (errors: ' . implode(', ', $errors) . ')'; + } + + throw new InvalidArgumentException($errorMessage); + } + if ($uri->getHost() !== $asciiHost) { + // Replace URI only if the ASCII version is different + $uri = $uri->withHost($asciiHost); + } + } + + return $uri; + } + + /** + * @internal + */ + public static function getenv(string $name): ?string + { + if (isset($_SERVER[$name])) { + return (string) $_SERVER[$name]; + } + + if (\PHP_SAPI === 'cli' && ($value = \getenv($name)) !== false && $value !== null) { + return (string) $value; + } + + return null; + } + + /** + * @return string|false + */ + private static function idnToAsci(string $domain, int $options, ?array &$info = []) + { + if (\function_exists('idn_to_ascii') && \defined('INTL_IDNA_VARIANT_UTS46')) { + return \idn_to_ascii($domain, $options, \INTL_IDNA_VARIANT_UTS46, $info); + } + + throw new \Error('ext-idn or symfony/polyfill-intl-idn not loaded or too old'); + } +} diff --git a/lib/guzzlehttp/guzzle/src/functions.php b/lib/guzzlehttp/guzzle/src/functions.php new file mode 100644 index 00000000..a70d2cbf --- /dev/null +++ b/lib/guzzlehttp/guzzle/src/functions.php @@ -0,0 +1,167 @@ + +Copyright (c) 2015 Graham Campbell +Copyright (c) 2017 Tobias Schultze +Copyright (c) 2020 Tobias Nyholm + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/lib/guzzlehttp/promises/Makefile b/lib/guzzlehttp/promises/Makefile new file mode 100644 index 00000000..8d5b3ef9 --- /dev/null +++ b/lib/guzzlehttp/promises/Makefile @@ -0,0 +1,13 @@ +all: clean test + +test: + vendor/bin/phpunit + +coverage: + vendor/bin/phpunit --coverage-html=artifacts/coverage + +view-coverage: + open artifacts/coverage/index.html + +clean: + rm -rf artifacts/* diff --git a/lib/guzzlehttp/promises/README.md b/lib/guzzlehttp/promises/README.md new file mode 100644 index 00000000..c175fec7 --- /dev/null +++ b/lib/guzzlehttp/promises/README.md @@ -0,0 +1,547 @@ +# Guzzle Promises + +[Promises/A+](https://promisesaplus.com/) implementation that handles promise +chaining and resolution iteratively, allowing for "infinite" promise chaining +while keeping the stack size constant. Read [this blog post](https://blog.domenic.me/youre-missing-the-point-of-promises/) +for a general introduction to promises. + +- [Features](#features) +- [Quick start](#quick-start) +- [Synchronous wait](#synchronous-wait) +- [Cancellation](#cancellation) +- [API](#api) + - [Promise](#promise) + - [FulfilledPromise](#fulfilledpromise) + - [RejectedPromise](#rejectedpromise) +- [Promise interop](#promise-interop) +- [Implementation notes](#implementation-notes) + + +# Features + +- [Promises/A+](https://promisesaplus.com/) implementation. +- Promise resolution and chaining is handled iteratively, allowing for + "infinite" promise chaining. +- Promises have a synchronous `wait` method. +- Promises can be cancelled. +- Works with any object that has a `then` function. +- C# style async/await coroutine promises using + `GuzzleHttp\Promise\Coroutine::of()`. + + +# Quick start + +A *promise* represents the eventual result of an asynchronous operation. The +primary way of interacting with a promise is through its `then` method, which +registers callbacks to receive either a promise's eventual value or the reason +why the promise cannot be fulfilled. + + +## Callbacks + +Callbacks are registered with the `then` method by providing an optional +`$onFulfilled` followed by an optional `$onRejected` function. + + +```php +use GuzzleHttp\Promise\Promise; + +$promise = new Promise(); +$promise->then( + // $onFulfilled + function ($value) { + echo 'The promise was fulfilled.'; + }, + // $onRejected + function ($reason) { + echo 'The promise was rejected.'; + } +); +``` + +*Resolving* a promise means that you either fulfill a promise with a *value* or +reject a promise with a *reason*. Resolving a promises triggers callbacks +registered with the promises's `then` method. These callbacks are triggered +only once and in the order in which they were added. + + +## Resolving a promise + +Promises are fulfilled using the `resolve($value)` method. Resolving a promise +with any value other than a `GuzzleHttp\Promise\RejectedPromise` will trigger +all of the onFulfilled callbacks (resolving a promise with a rejected promise +will reject the promise and trigger the `$onRejected` callbacks). + +```php +use GuzzleHttp\Promise\Promise; + +$promise = new Promise(); +$promise + ->then(function ($value) { + // Return a value and don't break the chain + return "Hello, " . $value; + }) + // This then is executed after the first then and receives the value + // returned from the first then. + ->then(function ($value) { + echo $value; + }); + +// Resolving the promise triggers the $onFulfilled callbacks and outputs +// "Hello, reader." +$promise->resolve('reader.'); +``` + + +## Promise forwarding + +Promises can be chained one after the other. Each then in the chain is a new +promise. The return value of a promise is what's forwarded to the next +promise in the chain. Returning a promise in a `then` callback will cause the +subsequent promises in the chain to only be fulfilled when the returned promise +has been fulfilled. The next promise in the chain will be invoked with the +resolved value of the promise. + +```php +use GuzzleHttp\Promise\Promise; + +$promise = new Promise(); +$nextPromise = new Promise(); + +$promise + ->then(function ($value) use ($nextPromise) { + echo $value; + return $nextPromise; + }) + ->then(function ($value) { + echo $value; + }); + +// Triggers the first callback and outputs "A" +$promise->resolve('A'); +// Triggers the second callback and outputs "B" +$nextPromise->resolve('B'); +``` + +## Promise rejection + +When a promise is rejected, the `$onRejected` callbacks are invoked with the +rejection reason. + +```php +use GuzzleHttp\Promise\Promise; + +$promise = new Promise(); +$promise->then(null, function ($reason) { + echo $reason; +}); + +$promise->reject('Error!'); +// Outputs "Error!" +``` + +## Rejection forwarding + +If an exception is thrown in an `$onRejected` callback, subsequent +`$onRejected` callbacks are invoked with the thrown exception as the reason. + +```php +use GuzzleHttp\Promise\Promise; + +$promise = new Promise(); +$promise->then(null, function ($reason) { + throw new Exception($reason); +})->then(null, function ($reason) { + assert($reason->getMessage() === 'Error!'); +}); + +$promise->reject('Error!'); +``` + +You can also forward a rejection down the promise chain by returning a +`GuzzleHttp\Promise\RejectedPromise` in either an `$onFulfilled` or +`$onRejected` callback. + +```php +use GuzzleHttp\Promise\Promise; +use GuzzleHttp\Promise\RejectedPromise; + +$promise = new Promise(); +$promise->then(null, function ($reason) { + return new RejectedPromise($reason); +})->then(null, function ($reason) { + assert($reason === 'Error!'); +}); + +$promise->reject('Error!'); +``` + +If an exception is not thrown in a `$onRejected` callback and the callback +does not return a rejected promise, downstream `$onFulfilled` callbacks are +invoked using the value returned from the `$onRejected` callback. + +```php +use GuzzleHttp\Promise\Promise; + +$promise = new Promise(); +$promise + ->then(null, function ($reason) { + return "It's ok"; + }) + ->then(function ($value) { + assert($value === "It's ok"); + }); + +$promise->reject('Error!'); +``` + +# Synchronous wait + +You can synchronously force promises to complete using a promise's `wait` +method. When creating a promise, you can provide a wait function that is used +to synchronously force a promise to complete. When a wait function is invoked +it is expected to deliver a value to the promise or reject the promise. If the +wait function does not deliver a value, then an exception is thrown. The wait +function provided to a promise constructor is invoked when the `wait` function +of the promise is called. + +```php +$promise = new Promise(function () use (&$promise) { + $promise->resolve('foo'); +}); + +// Calling wait will return the value of the promise. +echo $promise->wait(); // outputs "foo" +``` + +If an exception is encountered while invoking the wait function of a promise, +the promise is rejected with the exception and the exception is thrown. + +```php +$promise = new Promise(function () use (&$promise) { + throw new Exception('foo'); +}); + +$promise->wait(); // throws the exception. +``` + +Calling `wait` on a promise that has been fulfilled will not trigger the wait +function. It will simply return the previously resolved value. + +```php +$promise = new Promise(function () { die('this is not called!'); }); +$promise->resolve('foo'); +echo $promise->wait(); // outputs "foo" +``` + +Calling `wait` on a promise that has been rejected will throw an exception. If +the rejection reason is an instance of `\Exception` the reason is thrown. +Otherwise, a `GuzzleHttp\Promise\RejectionException` is thrown and the reason +can be obtained by calling the `getReason` method of the exception. + +```php +$promise = new Promise(); +$promise->reject('foo'); +$promise->wait(); +``` + +> PHP Fatal error: Uncaught exception 'GuzzleHttp\Promise\RejectionException' with message 'The promise was rejected with value: foo' + + +## Unwrapping a promise + +When synchronously waiting on a promise, you are joining the state of the +promise into the current state of execution (i.e., return the value of the +promise if it was fulfilled or throw an exception if it was rejected). This is +called "unwrapping" the promise. Waiting on a promise will by default unwrap +the promise state. + +You can force a promise to resolve and *not* unwrap the state of the promise +by passing `false` to the first argument of the `wait` function: + +```php +$promise = new Promise(); +$promise->reject('foo'); +// This will not throw an exception. It simply ensures the promise has +// been resolved. +$promise->wait(false); +``` + +When unwrapping a promise, the resolved value of the promise will be waited +upon until the unwrapped value is not a promise. This means that if you resolve +promise A with a promise B and unwrap promise A, the value returned by the +wait function will be the value delivered to promise B. + +**Note**: when you do not unwrap the promise, no value is returned. + + +# Cancellation + +You can cancel a promise that has not yet been fulfilled using the `cancel()` +method of a promise. When creating a promise you can provide an optional +cancel function that when invoked cancels the action of computing a resolution +of the promise. + + +# API + + +## Promise + +When creating a promise object, you can provide an optional `$waitFn` and +`$cancelFn`. `$waitFn` is a function that is invoked with no arguments and is +expected to resolve the promise. `$cancelFn` is a function with no arguments +that is expected to cancel the computation of a promise. It is invoked when the +`cancel()` method of a promise is called. + +```php +use GuzzleHttp\Promise\Promise; + +$promise = new Promise( + function () use (&$promise) { + $promise->resolve('waited'); + }, + function () { + // do something that will cancel the promise computation (e.g., close + // a socket, cancel a database query, etc...) + } +); + +assert('waited' === $promise->wait()); +``` + +A promise has the following methods: + +- `then(callable $onFulfilled, callable $onRejected) : PromiseInterface` + + Appends fulfillment and rejection handlers to the promise, and returns a new promise resolving to the return value of the called handler. + +- `otherwise(callable $onRejected) : PromiseInterface` + + Appends a rejection handler callback to the promise, and returns a new promise resolving to the return value of the callback if it is called, or to its original fulfillment value if the promise is instead fulfilled. + +- `wait($unwrap = true) : mixed` + + Synchronously waits on the promise to complete. + + `$unwrap` controls whether or not the value of the promise is returned for a + fulfilled promise or if an exception is thrown if the promise is rejected. + This is set to `true` by default. + +- `cancel()` + + Attempts to cancel the promise if possible. The promise being cancelled and + the parent most ancestor that has not yet been resolved will also be + cancelled. Any promises waiting on the cancelled promise to resolve will also + be cancelled. + +- `getState() : string` + + Returns the state of the promise. One of `pending`, `fulfilled`, or + `rejected`. + +- `resolve($value)` + + Fulfills the promise with the given `$value`. + +- `reject($reason)` + + Rejects the promise with the given `$reason`. + + +## FulfilledPromise + +A fulfilled promise can be created to represent a promise that has been +fulfilled. + +```php +use GuzzleHttp\Promise\FulfilledPromise; + +$promise = new FulfilledPromise('value'); + +// Fulfilled callbacks are immediately invoked. +$promise->then(function ($value) { + echo $value; +}); +``` + + +## RejectedPromise + +A rejected promise can be created to represent a promise that has been +rejected. + +```php +use GuzzleHttp\Promise\RejectedPromise; + +$promise = new RejectedPromise('Error'); + +// Rejected callbacks are immediately invoked. +$promise->then(null, function ($reason) { + echo $reason; +}); +``` + + +# Promise interop + +This library works with foreign promises that have a `then` method. This means +you can use Guzzle promises with [React promises](https://github.com/reactphp/promise) +for example. When a foreign promise is returned inside of a then method +callback, promise resolution will occur recursively. + +```php +// Create a React promise +$deferred = new React\Promise\Deferred(); +$reactPromise = $deferred->promise(); + +// Create a Guzzle promise that is fulfilled with a React promise. +$guzzlePromise = new GuzzleHttp\Promise\Promise(); +$guzzlePromise->then(function ($value) use ($reactPromise) { + // Do something something with the value... + // Return the React promise + return $reactPromise; +}); +``` + +Please note that wait and cancel chaining is no longer possible when forwarding +a foreign promise. You will need to wrap a third-party promise with a Guzzle +promise in order to utilize wait and cancel functions with foreign promises. + + +## Event Loop Integration + +In order to keep the stack size constant, Guzzle promises are resolved +asynchronously using a task queue. When waiting on promises synchronously, the +task queue will be automatically run to ensure that the blocking promise and +any forwarded promises are resolved. When using promises asynchronously in an +event loop, you will need to run the task queue on each tick of the loop. If +you do not run the task queue, then promises will not be resolved. + +You can run the task queue using the `run()` method of the global task queue +instance. + +```php +// Get the global task queue +$queue = GuzzleHttp\Promise\Utils::queue(); +$queue->run(); +``` + +For example, you could use Guzzle promises with React using a periodic timer: + +```php +$loop = React\EventLoop\Factory::create(); +$loop->addPeriodicTimer(0, [$queue, 'run']); +``` + +*TODO*: Perhaps adding a `futureTick()` on each tick would be faster? + + +# Implementation notes + + +## Promise resolution and chaining is handled iteratively + +By shuffling pending handlers from one owner to another, promises are +resolved iteratively, allowing for "infinite" then chaining. + +```php +then(function ($v) { + // The stack size remains constant (a good thing) + echo xdebug_get_stack_depth() . ', '; + return $v + 1; + }); +} + +$parent->resolve(0); +var_dump($p->wait()); // int(1000) + +``` + +When a promise is fulfilled or rejected with a non-promise value, the promise +then takes ownership of the handlers of each child promise and delivers values +down the chain without using recursion. + +When a promise is resolved with another promise, the original promise transfers +all of its pending handlers to the new promise. When the new promise is +eventually resolved, all of the pending handlers are delivered the forwarded +value. + + +## A promise is the deferred. + +Some promise libraries implement promises using a deferred object to represent +a computation and a promise object to represent the delivery of the result of +the computation. This is a nice separation of computation and delivery because +consumers of the promise cannot modify the value that will be eventually +delivered. + +One side effect of being able to implement promise resolution and chaining +iteratively is that you need to be able for one promise to reach into the state +of another promise to shuffle around ownership of handlers. In order to achieve +this without making the handlers of a promise publicly mutable, a promise is +also the deferred value, allowing promises of the same parent class to reach +into and modify the private properties of promises of the same type. While this +does allow consumers of the value to modify the resolution or rejection of the +deferred, it is a small price to pay for keeping the stack size constant. + +```php +$promise = new Promise(); +$promise->then(function ($value) { echo $value; }); +// The promise is the deferred value, so you can deliver a value to it. +$promise->resolve('foo'); +// prints "foo" +``` + + +## Upgrading from Function API + +A static API was first introduced in 1.4.0, in order to mitigate problems with functions conflicting between global and local copies of the package. The function API will be removed in 2.0.0. A migration table has been provided here for your convenience: + +| Original Function | Replacement Method | +|----------------|----------------| +| `queue` | `Utils::queue` | +| `task` | `Utils::task` | +| `promise_for` | `Create::promiseFor` | +| `rejection_for` | `Create::rejectionFor` | +| `exception_for` | `Create::exceptionFor` | +| `iter_for` | `Create::iterFor` | +| `inspect` | `Utils::inspect` | +| `inspect_all` | `Utils::inspectAll` | +| `unwrap` | `Utils::unwrap` | +| `all` | `Utils::all` | +| `some` | `Utils::some` | +| `any` | `Utils::any` | +| `settle` | `Utils::settle` | +| `each` | `Each::of` | +| `each_limit` | `Each::ofLimit` | +| `each_limit_all` | `Each::ofLimitAll` | +| `!is_fulfilled` | `Is::pending` | +| `is_fulfilled` | `Is::fulfilled` | +| `is_rejected` | `Is::rejected` | +| `is_settled` | `Is::settled` | +| `coroutine` | `Coroutine::of` | + + +## Security + +If you discover a security vulnerability within this package, please send an email to security@tidelift.com. All security vulnerabilities will be promptly addressed. Please do not disclose security-related issues publicly until a fix has been announced. Please see [Security Policy](https://github.com/guzzle/promises/security/policy) for more information. + +## License + +Guzzle is made available under the MIT License (MIT). Please see [License File](LICENSE) for more information. + +## For Enterprise + +Available as part of the Tidelift Subscription + +The maintainers of Guzzle and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. [Learn more.](https://tidelift.com/subscription/pkg/packagist-guzzlehttp-promises?utm_source=packagist-guzzlehttp-promises&utm_medium=referral&utm_campaign=enterprise&utm_term=repo) diff --git a/lib/guzzlehttp/promises/composer.json b/lib/guzzlehttp/promises/composer.json new file mode 100644 index 00000000..c959fb32 --- /dev/null +++ b/lib/guzzlehttp/promises/composer.json @@ -0,0 +1,58 @@ +{ + "name": "guzzlehttp/promises", + "description": "Guzzle promises library", + "keywords": ["promise"], + "license": "MIT", + "authors": [ + { + "name": "Graham Campbell", + "email": "hello@gjcampbell.co.uk", + "homepage": "https://github.com/GrahamCampbell" + }, + { + "name": "Michael Dowling", + "email": "mtdowling@gmail.com", + "homepage": "https://github.com/mtdowling" + }, + { + "name": "Tobias Nyholm", + "email": "tobias.nyholm@gmail.com", + "homepage": "https://github.com/Nyholm" + }, + { + "name": "Tobias Schultze", + "email": "webmaster@tubo-world.de", + "homepage": "https://github.com/Tobion" + } + ], + "require": { + "php": ">=5.5" + }, + "require-dev": { + "symfony/phpunit-bridge": "^4.4 || ^5.1" + }, + "autoload": { + "psr-4": { + "GuzzleHttp\\Promise\\": "src/" + }, + "files": ["src/functions_include.php"] + }, + "autoload-dev": { + "psr-4": { + "GuzzleHttp\\Promise\\Tests\\": "tests/" + } + }, + "scripts": { + "test": "vendor/bin/simple-phpunit", + "test-ci": "vendor/bin/simple-phpunit --coverage-text" + }, + "extra": { + "branch-alias": { + "dev-master": "1.5-dev" + } + }, + "config": { + "preferred-install": "dist", + "sort-packages": true + } +} diff --git a/lib/guzzlehttp/promises/src/AggregateException.php b/lib/guzzlehttp/promises/src/AggregateException.php new file mode 100644 index 00000000..d2b5712b --- /dev/null +++ b/lib/guzzlehttp/promises/src/AggregateException.php @@ -0,0 +1,17 @@ +then(function ($v) { echo $v; }); + * + * @param callable $generatorFn Generator function to wrap into a promise. + * + * @return Promise + * + * @link https://github.com/petkaantonov/bluebird/blob/master/API.md#generators inspiration + */ +final class Coroutine implements PromiseInterface +{ + /** + * @var PromiseInterface|null + */ + private $currentPromise; + + /** + * @var Generator + */ + private $generator; + + /** + * @var Promise + */ + private $result; + + public function __construct(callable $generatorFn) + { + $this->generator = $generatorFn(); + $this->result = new Promise(function () { + while (isset($this->currentPromise)) { + $this->currentPromise->wait(); + } + }); + try { + $this->nextCoroutine($this->generator->current()); + } catch (\Exception $exception) { + $this->result->reject($exception); + } catch (Throwable $throwable) { + $this->result->reject($throwable); + } + } + + /** + * Create a new coroutine. + * + * @return self + */ + public static function of(callable $generatorFn) + { + return new self($generatorFn); + } + + public function then( + callable $onFulfilled = null, + callable $onRejected = null + ) { + return $this->result->then($onFulfilled, $onRejected); + } + + public function otherwise(callable $onRejected) + { + return $this->result->otherwise($onRejected); + } + + public function wait($unwrap = true) + { + return $this->result->wait($unwrap); + } + + public function getState() + { + return $this->result->getState(); + } + + public function resolve($value) + { + $this->result->resolve($value); + } + + public function reject($reason) + { + $this->result->reject($reason); + } + + public function cancel() + { + $this->currentPromise->cancel(); + $this->result->cancel(); + } + + private function nextCoroutine($yielded) + { + $this->currentPromise = Create::promiseFor($yielded) + ->then([$this, '_handleSuccess'], [$this, '_handleFailure']); + } + + /** + * @internal + */ + public function _handleSuccess($value) + { + unset($this->currentPromise); + try { + $next = $this->generator->send($value); + if ($this->generator->valid()) { + $this->nextCoroutine($next); + } else { + $this->result->resolve($value); + } + } catch (Exception $exception) { + $this->result->reject($exception); + } catch (Throwable $throwable) { + $this->result->reject($throwable); + } + } + + /** + * @internal + */ + public function _handleFailure($reason) + { + unset($this->currentPromise); + try { + $nextYield = $this->generator->throw(Create::exceptionFor($reason)); + // The throw was caught, so keep iterating on the coroutine + $this->nextCoroutine($nextYield); + } catch (Exception $exception) { + $this->result->reject($exception); + } catch (Throwable $throwable) { + $this->result->reject($throwable); + } + } +} diff --git a/lib/guzzlehttp/promises/src/Create.php b/lib/guzzlehttp/promises/src/Create.php new file mode 100644 index 00000000..8d038e9c --- /dev/null +++ b/lib/guzzlehttp/promises/src/Create.php @@ -0,0 +1,84 @@ +then([$promise, 'resolve'], [$promise, 'reject']); + return $promise; + } + + return new FulfilledPromise($value); + } + + /** + * Creates a rejected promise for a reason if the reason is not a promise. + * If the provided reason is a promise, then it is returned as-is. + * + * @param mixed $reason Promise or reason. + * + * @return PromiseInterface + */ + public static function rejectionFor($reason) + { + if ($reason instanceof PromiseInterface) { + return $reason; + } + + return new RejectedPromise($reason); + } + + /** + * Create an exception for a rejected promise value. + * + * @param mixed $reason + * + * @return \Exception|\Throwable + */ + public static function exceptionFor($reason) + { + if ($reason instanceof \Exception || $reason instanceof \Throwable) { + return $reason; + } + + return new RejectionException($reason); + } + + /** + * Returns an iterator for the given value. + * + * @param mixed $value + * + * @return \Iterator + */ + public static function iterFor($value) + { + if ($value instanceof \Iterator) { + return $value; + } + + if (is_array($value)) { + return new \ArrayIterator($value); + } + + return new \ArrayIterator([$value]); + } +} diff --git a/lib/guzzlehttp/promises/src/Each.php b/lib/guzzlehttp/promises/src/Each.php new file mode 100644 index 00000000..1dda3549 --- /dev/null +++ b/lib/guzzlehttp/promises/src/Each.php @@ -0,0 +1,90 @@ + $onFulfilled, + 'rejected' => $onRejected + ]))->promise(); + } + + /** + * Like of, but only allows a certain number of outstanding promises at any + * given time. + * + * $concurrency may be an integer or a function that accepts the number of + * pending promises and returns a numeric concurrency limit value to allow + * for dynamic a concurrency size. + * + * @param mixed $iterable + * @param int|callable $concurrency + * @param callable $onFulfilled + * @param callable $onRejected + * + * @return PromiseInterface + */ + public static function ofLimit( + $iterable, + $concurrency, + callable $onFulfilled = null, + callable $onRejected = null + ) { + return (new EachPromise($iterable, [ + 'fulfilled' => $onFulfilled, + 'rejected' => $onRejected, + 'concurrency' => $concurrency + ]))->promise(); + } + + /** + * Like limit, but ensures that no promise in the given $iterable argument + * is rejected. If any promise is rejected, then the aggregate promise is + * rejected with the encountered rejection. + * + * @param mixed $iterable + * @param int|callable $concurrency + * @param callable $onFulfilled + * + * @return PromiseInterface + */ + public static function ofLimitAll( + $iterable, + $concurrency, + callable $onFulfilled = null + ) { + return each_limit( + $iterable, + $concurrency, + $onFulfilled, + function ($reason, $idx, PromiseInterface $aggregate) { + $aggregate->reject($reason); + } + ); + } +} diff --git a/lib/guzzlehttp/promises/src/EachPromise.php b/lib/guzzlehttp/promises/src/EachPromise.php new file mode 100644 index 00000000..38ecb59b --- /dev/null +++ b/lib/guzzlehttp/promises/src/EachPromise.php @@ -0,0 +1,255 @@ +iterable = Create::iterFor($iterable); + + if (isset($config['concurrency'])) { + $this->concurrency = $config['concurrency']; + } + + if (isset($config['fulfilled'])) { + $this->onFulfilled = $config['fulfilled']; + } + + if (isset($config['rejected'])) { + $this->onRejected = $config['rejected']; + } + } + + /** @psalm-suppress InvalidNullableReturnType */ + public function promise() + { + if ($this->aggregate) { + return $this->aggregate; + } + + try { + $this->createPromise(); + /** @psalm-assert Promise $this->aggregate */ + $this->iterable->rewind(); + $this->refillPending(); + } catch (\Throwable $e) { + /** + * @psalm-suppress NullReference + * @phpstan-ignore-next-line + */ + $this->aggregate->reject($e); + } catch (\Exception $e) { + /** + * @psalm-suppress NullReference + * @phpstan-ignore-next-line + */ + $this->aggregate->reject($e); + } + + /** + * @psalm-suppress NullableReturnStatement + * @phpstan-ignore-next-line + */ + return $this->aggregate; + } + + private function createPromise() + { + $this->mutex = false; + $this->aggregate = new Promise(function () { + if ($this->checkIfFinished()) { + return; + } + reset($this->pending); + // Consume a potentially fluctuating list of promises while + // ensuring that indexes are maintained (precluding array_shift). + while ($promise = current($this->pending)) { + next($this->pending); + $promise->wait(); + if (Is::settled($this->aggregate)) { + return; + } + } + }); + + // Clear the references when the promise is resolved. + $clearFn = function () { + $this->iterable = $this->concurrency = $this->pending = null; + $this->onFulfilled = $this->onRejected = null; + $this->nextPendingIndex = 0; + }; + + $this->aggregate->then($clearFn, $clearFn); + } + + private function refillPending() + { + if (!$this->concurrency) { + // Add all pending promises. + while ($this->addPending() && $this->advanceIterator()); + return; + } + + // Add only up to N pending promises. + $concurrency = is_callable($this->concurrency) + ? call_user_func($this->concurrency, count($this->pending)) + : $this->concurrency; + $concurrency = max($concurrency - count($this->pending), 0); + // Concurrency may be set to 0 to disallow new promises. + if (!$concurrency) { + return; + } + // Add the first pending promise. + $this->addPending(); + // Note this is special handling for concurrency=1 so that we do + // not advance the iterator after adding the first promise. This + // helps work around issues with generators that might not have the + // next value to yield until promise callbacks are called. + while (--$concurrency + && $this->advanceIterator() + && $this->addPending()); + } + + private function addPending() + { + if (!$this->iterable || !$this->iterable->valid()) { + return false; + } + + $promise = Create::promiseFor($this->iterable->current()); + $key = $this->iterable->key(); + + // Iterable keys may not be unique, so we use a counter to + // guarantee uniqueness + $idx = $this->nextPendingIndex++; + + $this->pending[$idx] = $promise->then( + function ($value) use ($idx, $key) { + if ($this->onFulfilled) { + call_user_func( + $this->onFulfilled, + $value, + $key, + $this->aggregate + ); + } + $this->step($idx); + }, + function ($reason) use ($idx, $key) { + if ($this->onRejected) { + call_user_func( + $this->onRejected, + $reason, + $key, + $this->aggregate + ); + } + $this->step($idx); + } + ); + + return true; + } + + private function advanceIterator() + { + // Place a lock on the iterator so that we ensure to not recurse, + // preventing fatal generator errors. + if ($this->mutex) { + return false; + } + + $this->mutex = true; + + try { + $this->iterable->next(); + $this->mutex = false; + return true; + } catch (\Throwable $e) { + $this->aggregate->reject($e); + $this->mutex = false; + return false; + } catch (\Exception $e) { + $this->aggregate->reject($e); + $this->mutex = false; + return false; + } + } + + private function step($idx) + { + // If the promise was already resolved, then ignore this step. + if (Is::settled($this->aggregate)) { + return; + } + + unset($this->pending[$idx]); + + // Only refill pending promises if we are not locked, preventing the + // EachPromise to recursively invoke the provided iterator, which + // cause a fatal error: "Cannot resume an already running generator" + if ($this->advanceIterator() && !$this->checkIfFinished()) { + // Add more pending promises if possible. + $this->refillPending(); + } + } + + private function checkIfFinished() + { + if (!$this->pending && !$this->iterable->valid()) { + // Resolve the promise if there's nothing left to do. + $this->aggregate->resolve(null); + return true; + } + + return false; + } +} diff --git a/lib/guzzlehttp/promises/src/FulfilledPromise.php b/lib/guzzlehttp/promises/src/FulfilledPromise.php new file mode 100644 index 00000000..98f72a62 --- /dev/null +++ b/lib/guzzlehttp/promises/src/FulfilledPromise.php @@ -0,0 +1,84 @@ +value = $value; + } + + public function then( + callable $onFulfilled = null, + callable $onRejected = null + ) { + // Return itself if there is no onFulfilled function. + if (!$onFulfilled) { + return $this; + } + + $queue = Utils::queue(); + $p = new Promise([$queue, 'run']); + $value = $this->value; + $queue->add(static function () use ($p, $value, $onFulfilled) { + if (Is::pending($p)) { + try { + $p->resolve($onFulfilled($value)); + } catch (\Throwable $e) { + $p->reject($e); + } catch (\Exception $e) { + $p->reject($e); + } + } + }); + + return $p; + } + + public function otherwise(callable $onRejected) + { + return $this->then(null, $onRejected); + } + + public function wait($unwrap = true, $defaultDelivery = null) + { + return $unwrap ? $this->value : null; + } + + public function getState() + { + return self::FULFILLED; + } + + public function resolve($value) + { + if ($value !== $this->value) { + throw new \LogicException("Cannot resolve a fulfilled promise"); + } + } + + public function reject($reason) + { + throw new \LogicException("Cannot reject a fulfilled promise"); + } + + public function cancel() + { + // pass + } +} diff --git a/lib/guzzlehttp/promises/src/Is.php b/lib/guzzlehttp/promises/src/Is.php new file mode 100644 index 00000000..c3ed8d01 --- /dev/null +++ b/lib/guzzlehttp/promises/src/Is.php @@ -0,0 +1,46 @@ +getState() === PromiseInterface::PENDING; + } + + /** + * Returns true if a promise is fulfilled or rejected. + * + * @return bool + */ + public static function settled(PromiseInterface $promise) + { + return $promise->getState() !== PromiseInterface::PENDING; + } + + /** + * Returns true if a promise is fulfilled. + * + * @return bool + */ + public static function fulfilled(PromiseInterface $promise) + { + return $promise->getState() === PromiseInterface::FULFILLED; + } + + /** + * Returns true if a promise is rejected. + * + * @return bool + */ + public static function rejected(PromiseInterface $promise) + { + return $promise->getState() === PromiseInterface::REJECTED; + } +} diff --git a/lib/guzzlehttp/promises/src/Promise.php b/lib/guzzlehttp/promises/src/Promise.php new file mode 100644 index 00000000..75939057 --- /dev/null +++ b/lib/guzzlehttp/promises/src/Promise.php @@ -0,0 +1,278 @@ +waitFn = $waitFn; + $this->cancelFn = $cancelFn; + } + + public function then( + callable $onFulfilled = null, + callable $onRejected = null + ) { + if ($this->state === self::PENDING) { + $p = new Promise(null, [$this, 'cancel']); + $this->handlers[] = [$p, $onFulfilled, $onRejected]; + $p->waitList = $this->waitList; + $p->waitList[] = $this; + return $p; + } + + // Return a fulfilled promise and immediately invoke any callbacks. + if ($this->state === self::FULFILLED) { + $promise = Create::promiseFor($this->result); + return $onFulfilled ? $promise->then($onFulfilled) : $promise; + } + + // It's either cancelled or rejected, so return a rejected promise + // and immediately invoke any callbacks. + $rejection = Create::rejectionFor($this->result); + return $onRejected ? $rejection->then(null, $onRejected) : $rejection; + } + + public function otherwise(callable $onRejected) + { + return $this->then(null, $onRejected); + } + + public function wait($unwrap = true) + { + $this->waitIfPending(); + + if ($this->result instanceof PromiseInterface) { + return $this->result->wait($unwrap); + } + if ($unwrap) { + if ($this->state === self::FULFILLED) { + return $this->result; + } + // It's rejected so "unwrap" and throw an exception. + throw Create::exceptionFor($this->result); + } + } + + public function getState() + { + return $this->state; + } + + public function cancel() + { + if ($this->state !== self::PENDING) { + return; + } + + $this->waitFn = $this->waitList = null; + + if ($this->cancelFn) { + $fn = $this->cancelFn; + $this->cancelFn = null; + try { + $fn(); + } catch (\Throwable $e) { + $this->reject($e); + } catch (\Exception $e) { + $this->reject($e); + } + } + + // Reject the promise only if it wasn't rejected in a then callback. + /** @psalm-suppress RedundantCondition */ + if ($this->state === self::PENDING) { + $this->reject(new CancellationException('Promise has been cancelled')); + } + } + + public function resolve($value) + { + $this->settle(self::FULFILLED, $value); + } + + public function reject($reason) + { + $this->settle(self::REJECTED, $reason); + } + + private function settle($state, $value) + { + if ($this->state !== self::PENDING) { + // Ignore calls with the same resolution. + if ($state === $this->state && $value === $this->result) { + return; + } + throw $this->state === $state + ? new \LogicException("The promise is already {$state}.") + : new \LogicException("Cannot change a {$this->state} promise to {$state}"); + } + + if ($value === $this) { + throw new \LogicException('Cannot fulfill or reject a promise with itself'); + } + + // Clear out the state of the promise but stash the handlers. + $this->state = $state; + $this->result = $value; + $handlers = $this->handlers; + $this->handlers = null; + $this->waitList = $this->waitFn = null; + $this->cancelFn = null; + + if (!$handlers) { + return; + } + + // If the value was not a settled promise or a thenable, then resolve + // it in the task queue using the correct ID. + if (!is_object($value) || !method_exists($value, 'then')) { + $id = $state === self::FULFILLED ? 1 : 2; + // It's a success, so resolve the handlers in the queue. + Utils::queue()->add(static function () use ($id, $value, $handlers) { + foreach ($handlers as $handler) { + self::callHandler($id, $value, $handler); + } + }); + } elseif ($value instanceof Promise && Is::pending($value)) { + // We can just merge our handlers onto the next promise. + $value->handlers = array_merge($value->handlers, $handlers); + } else { + // Resolve the handlers when the forwarded promise is resolved. + $value->then( + static function ($value) use ($handlers) { + foreach ($handlers as $handler) { + self::callHandler(1, $value, $handler); + } + }, + static function ($reason) use ($handlers) { + foreach ($handlers as $handler) { + self::callHandler(2, $reason, $handler); + } + } + ); + } + } + + /** + * Call a stack of handlers using a specific callback index and value. + * + * @param int $index 1 (resolve) or 2 (reject). + * @param mixed $value Value to pass to the callback. + * @param array $handler Array of handler data (promise and callbacks). + */ + private static function callHandler($index, $value, array $handler) + { + /** @var PromiseInterface $promise */ + $promise = $handler[0]; + + // The promise may have been cancelled or resolved before placing + // this thunk in the queue. + if (Is::settled($promise)) { + return; + } + + try { + if (isset($handler[$index])) { + /* + * If $f throws an exception, then $handler will be in the exception + * stack trace. Since $handler contains a reference to the callable + * itself we get a circular reference. We clear the $handler + * here to avoid that memory leak. + */ + $f = $handler[$index]; + unset($handler); + $promise->resolve($f($value)); + } elseif ($index === 1) { + // Forward resolution values as-is. + $promise->resolve($value); + } else { + // Forward rejections down the chain. + $promise->reject($value); + } + } catch (\Throwable $reason) { + $promise->reject($reason); + } catch (\Exception $reason) { + $promise->reject($reason); + } + } + + private function waitIfPending() + { + if ($this->state !== self::PENDING) { + return; + } elseif ($this->waitFn) { + $this->invokeWaitFn(); + } elseif ($this->waitList) { + $this->invokeWaitList(); + } else { + // If there's no wait function, then reject the promise. + $this->reject('Cannot wait on a promise that has ' + . 'no internal wait function. You must provide a wait ' + . 'function when constructing the promise to be able to ' + . 'wait on a promise.'); + } + + Utils::queue()->run(); + + /** @psalm-suppress RedundantCondition */ + if ($this->state === self::PENDING) { + $this->reject('Invoking the wait callback did not resolve the promise'); + } + } + + private function invokeWaitFn() + { + try { + $wfn = $this->waitFn; + $this->waitFn = null; + $wfn(true); + } catch (\Exception $reason) { + if ($this->state === self::PENDING) { + // The promise has not been resolved yet, so reject the promise + // with the exception. + $this->reject($reason); + } else { + // The promise was already resolved, so there's a problem in + // the application. + throw $reason; + } + } + } + + private function invokeWaitList() + { + $waitList = $this->waitList; + $this->waitList = null; + + foreach ($waitList as $result) { + do { + $result->waitIfPending(); + $result = $result->result; + } while ($result instanceof Promise); + + if ($result instanceof PromiseInterface) { + $result->wait(false); + } + } + } +} diff --git a/lib/guzzlehttp/promises/src/PromiseInterface.php b/lib/guzzlehttp/promises/src/PromiseInterface.php new file mode 100644 index 00000000..e5983314 --- /dev/null +++ b/lib/guzzlehttp/promises/src/PromiseInterface.php @@ -0,0 +1,97 @@ +reason = $reason; + } + + public function then( + callable $onFulfilled = null, + callable $onRejected = null + ) { + // If there's no onRejected callback then just return self. + if (!$onRejected) { + return $this; + } + + $queue = Utils::queue(); + $reason = $this->reason; + $p = new Promise([$queue, 'run']); + $queue->add(static function () use ($p, $reason, $onRejected) { + if (Is::pending($p)) { + try { + // Return a resolved promise if onRejected does not throw. + $p->resolve($onRejected($reason)); + } catch (\Throwable $e) { + // onRejected threw, so return a rejected promise. + $p->reject($e); + } catch (\Exception $e) { + // onRejected threw, so return a rejected promise. + $p->reject($e); + } + } + }); + + return $p; + } + + public function otherwise(callable $onRejected) + { + return $this->then(null, $onRejected); + } + + public function wait($unwrap = true, $defaultDelivery = null) + { + if ($unwrap) { + throw Create::exceptionFor($this->reason); + } + + return null; + } + + public function getState() + { + return self::REJECTED; + } + + public function resolve($value) + { + throw new \LogicException("Cannot resolve a rejected promise"); + } + + public function reject($reason) + { + if ($reason !== $this->reason) { + throw new \LogicException("Cannot reject a rejected promise"); + } + } + + public function cancel() + { + // pass + } +} diff --git a/lib/guzzlehttp/promises/src/RejectionException.php b/lib/guzzlehttp/promises/src/RejectionException.php new file mode 100644 index 00000000..e2f13770 --- /dev/null +++ b/lib/guzzlehttp/promises/src/RejectionException.php @@ -0,0 +1,48 @@ +reason = $reason; + + $message = 'The promise was rejected'; + + if ($description) { + $message .= ' with reason: ' . $description; + } elseif (is_string($reason) + || (is_object($reason) && method_exists($reason, '__toString')) + ) { + $message .= ' with reason: ' . $this->reason; + } elseif ($reason instanceof \JsonSerializable) { + $message .= ' with reason: ' + . json_encode($this->reason, JSON_PRETTY_PRINT); + } + + parent::__construct($message); + } + + /** + * Returns the rejection reason. + * + * @return mixed + */ + public function getReason() + { + return $this->reason; + } +} diff --git a/lib/guzzlehttp/promises/src/TaskQueue.php b/lib/guzzlehttp/promises/src/TaskQueue.php new file mode 100644 index 00000000..f0fba2c5 --- /dev/null +++ b/lib/guzzlehttp/promises/src/TaskQueue.php @@ -0,0 +1,67 @@ +run(); + */ +class TaskQueue implements TaskQueueInterface +{ + private $enableShutdown = true; + private $queue = []; + + public function __construct($withShutdown = true) + { + if ($withShutdown) { + register_shutdown_function(function () { + if ($this->enableShutdown) { + // Only run the tasks if an E_ERROR didn't occur. + $err = error_get_last(); + if (!$err || ($err['type'] ^ E_ERROR)) { + $this->run(); + } + } + }); + } + } + + public function isEmpty() + { + return !$this->queue; + } + + public function add(callable $task) + { + $this->queue[] = $task; + } + + public function run() + { + while ($task = array_shift($this->queue)) { + /** @var callable $task */ + $task(); + } + } + + /** + * The task queue will be run and exhausted by default when the process + * exits IFF the exit is not the result of a PHP E_ERROR error. + * + * You can disable running the automatic shutdown of the queue by calling + * this function. If you disable the task queue shutdown process, then you + * MUST either run the task queue (as a result of running your event loop + * or manually using the run() method) or wait on each outstanding promise. + * + * Note: This shutdown will occur before any destructors are triggered. + */ + public function disableShutdown() + { + $this->enableShutdown = false; + } +} diff --git a/lib/guzzlehttp/promises/src/TaskQueueInterface.php b/lib/guzzlehttp/promises/src/TaskQueueInterface.php new file mode 100644 index 00000000..723d4d54 --- /dev/null +++ b/lib/guzzlehttp/promises/src/TaskQueueInterface.php @@ -0,0 +1,24 @@ + + * while ($eventLoop->isRunning()) { + * GuzzleHttp\Promise\Utils::queue()->run(); + * } + * + * + * @param TaskQueueInterface $assign Optionally specify a new queue instance. + * + * @return TaskQueueInterface + */ + public static function queue(TaskQueueInterface $assign = null) + { + static $queue; + + if ($assign) { + $queue = $assign; + } elseif (!$queue) { + $queue = new TaskQueue(); + } + + return $queue; + } + + /** + * Adds a function to run in the task queue when it is next `run()` and + * returns a promise that is fulfilled or rejected with the result. + * + * @param callable $task Task function to run. + * + * @return PromiseInterface + */ + public static function task(callable $task) + { + $queue = self::queue(); + $promise = new Promise([$queue, 'run']); + $queue->add(function () use ($task, $promise) { + try { + if (Is::pending($promise)) { + $promise->resolve($task()); + } + } catch (\Throwable $e) { + $promise->reject($e); + } catch (\Exception $e) { + $promise->reject($e); + } + }); + + return $promise; + } + + /** + * Synchronously waits on a promise to resolve and returns an inspection + * state array. + * + * Returns a state associative array containing a "state" key mapping to a + * valid promise state. If the state of the promise is "fulfilled", the + * array will contain a "value" key mapping to the fulfilled value of the + * promise. If the promise is rejected, the array will contain a "reason" + * key mapping to the rejection reason of the promise. + * + * @param PromiseInterface $promise Promise or value. + * + * @return array + */ + public static function inspect(PromiseInterface $promise) + { + try { + return [ + 'state' => PromiseInterface::FULFILLED, + 'value' => $promise->wait() + ]; + } catch (RejectionException $e) { + return ['state' => PromiseInterface::REJECTED, 'reason' => $e->getReason()]; + } catch (\Throwable $e) { + return ['state' => PromiseInterface::REJECTED, 'reason' => $e]; + } catch (\Exception $e) { + return ['state' => PromiseInterface::REJECTED, 'reason' => $e]; + } + } + + /** + * Waits on all of the provided promises, but does not unwrap rejected + * promises as thrown exception. + * + * Returns an array of inspection state arrays. + * + * @see inspect for the inspection state array format. + * + * @param PromiseInterface[] $promises Traversable of promises to wait upon. + * + * @return array + */ + public static function inspectAll($promises) + { + $results = []; + foreach ($promises as $key => $promise) { + $results[$key] = inspect($promise); + } + + return $results; + } + + /** + * Waits on all of the provided promises and returns the fulfilled values. + * + * Returns an array that contains the value of each promise (in the same + * order the promises were provided). An exception is thrown if any of the + * promises are rejected. + * + * @param iterable $promises Iterable of PromiseInterface objects to wait on. + * + * @return array + * + * @throws \Exception on error + * @throws \Throwable on error in PHP >=7 + */ + public static function unwrap($promises) + { + $results = []; + foreach ($promises as $key => $promise) { + $results[$key] = $promise->wait(); + } + + return $results; + } + + /** + * Given an array of promises, return a promise that is fulfilled when all + * the items in the array are fulfilled. + * + * The promise's fulfillment value is an array with fulfillment values at + * respective positions to the original array. If any promise in the array + * rejects, the returned promise is rejected with the rejection reason. + * + * @param mixed $promises Promises or values. + * @param bool $recursive If true, resolves new promises that might have been added to the stack during its own resolution. + * + * @return PromiseInterface + */ + public static function all($promises, $recursive = false) + { + $results = []; + $promise = Each::of( + $promises, + function ($value, $idx) use (&$results) { + $results[$idx] = $value; + }, + function ($reason, $idx, Promise $aggregate) { + $aggregate->reject($reason); + } + )->then(function () use (&$results) { + ksort($results); + return $results; + }); + + if (true === $recursive) { + $promise = $promise->then(function ($results) use ($recursive, &$promises) { + foreach ($promises as $promise) { + if (Is::pending($promise)) { + return self::all($promises, $recursive); + } + } + return $results; + }); + } + + return $promise; + } + + /** + * Initiate a competitive race between multiple promises or values (values + * will become immediately fulfilled promises). + * + * When count amount of promises have been fulfilled, the returned promise + * is fulfilled with an array that contains the fulfillment values of the + * winners in order of resolution. + * + * This promise is rejected with a {@see AggregateException} if the number + * of fulfilled promises is less than the desired $count. + * + * @param int $count Total number of promises. + * @param mixed $promises Promises or values. + * + * @return PromiseInterface + */ + public static function some($count, $promises) + { + $results = []; + $rejections = []; + + return Each::of( + $promises, + function ($value, $idx, PromiseInterface $p) use (&$results, $count) { + if (Is::settled($p)) { + return; + } + $results[$idx] = $value; + if (count($results) >= $count) { + $p->resolve(null); + } + }, + function ($reason) use (&$rejections) { + $rejections[] = $reason; + } + )->then( + function () use (&$results, &$rejections, $count) { + if (count($results) !== $count) { + throw new AggregateException( + 'Not enough promises to fulfill count', + $rejections + ); + } + ksort($results); + return array_values($results); + } + ); + } + + /** + * Like some(), with 1 as count. However, if the promise fulfills, the + * fulfillment value is not an array of 1 but the value directly. + * + * @param mixed $promises Promises or values. + * + * @return PromiseInterface + */ + public static function any($promises) + { + return self::some(1, $promises)->then(function ($values) { + return $values[0]; + }); + } + + /** + * Returns a promise that is fulfilled when all of the provided promises have + * been fulfilled or rejected. + * + * The returned promise is fulfilled with an array of inspection state arrays. + * + * @see inspect for the inspection state array format. + * + * @param mixed $promises Promises or values. + * + * @return PromiseInterface + */ + public static function settle($promises) + { + $results = []; + + return Each::of( + $promises, + function ($value, $idx) use (&$results) { + $results[$idx] = ['state' => PromiseInterface::FULFILLED, 'value' => $value]; + }, + function ($reason, $idx) use (&$results) { + $results[$idx] = ['state' => PromiseInterface::REJECTED, 'reason' => $reason]; + } + )->then(function () use (&$results) { + ksort($results); + return $results; + }); + } +} diff --git a/lib/guzzlehttp/promises/src/functions.php b/lib/guzzlehttp/promises/src/functions.php new file mode 100644 index 00000000..c03d39d0 --- /dev/null +++ b/lib/guzzlehttp/promises/src/functions.php @@ -0,0 +1,363 @@ + + * while ($eventLoop->isRunning()) { + * GuzzleHttp\Promise\queue()->run(); + * } + * + * + * @param TaskQueueInterface $assign Optionally specify a new queue instance. + * + * @return TaskQueueInterface + * + * @deprecated queue will be removed in guzzlehttp/promises:2.0. Use Utils::queue instead. + */ +function queue(TaskQueueInterface $assign = null) +{ + return Utils::queue($assign); +} + +/** + * Adds a function to run in the task queue when it is next `run()` and returns + * a promise that is fulfilled or rejected with the result. + * + * @param callable $task Task function to run. + * + * @return PromiseInterface + * + * @deprecated task will be removed in guzzlehttp/promises:2.0. Use Utils::task instead. + */ +function task(callable $task) +{ + return Utils::task($task); +} + +/** + * Creates a promise for a value if the value is not a promise. + * + * @param mixed $value Promise or value. + * + * @return PromiseInterface + * + * @deprecated promise_for will be removed in guzzlehttp/promises:2.0. Use Create::promiseFor instead. + */ +function promise_for($value) +{ + return Create::promiseFor($value); +} + +/** + * Creates a rejected promise for a reason if the reason is not a promise. If + * the provided reason is a promise, then it is returned as-is. + * + * @param mixed $reason Promise or reason. + * + * @return PromiseInterface + * + * @deprecated rejection_for will be removed in guzzlehttp/promises:2.0. Use Create::rejectionFor instead. + */ +function rejection_for($reason) +{ + return Create::rejectionFor($reason); +} + +/** + * Create an exception for a rejected promise value. + * + * @param mixed $reason + * + * @return \Exception|\Throwable + * + * @deprecated exception_for will be removed in guzzlehttp/promises:2.0. Use Create::exceptionFor instead. + */ +function exception_for($reason) +{ + return Create::exceptionFor($reason); +} + +/** + * Returns an iterator for the given value. + * + * @param mixed $value + * + * @return \Iterator + * + * @deprecated iter_for will be removed in guzzlehttp/promises:2.0. Use Create::iterFor instead. + */ +function iter_for($value) +{ + return Create::iterFor($value); +} + +/** + * Synchronously waits on a promise to resolve and returns an inspection state + * array. + * + * Returns a state associative array containing a "state" key mapping to a + * valid promise state. If the state of the promise is "fulfilled", the array + * will contain a "value" key mapping to the fulfilled value of the promise. If + * the promise is rejected, the array will contain a "reason" key mapping to + * the rejection reason of the promise. + * + * @param PromiseInterface $promise Promise or value. + * + * @return array + * + * @deprecated inspect will be removed in guzzlehttp/promises:2.0. Use Utils::inspect instead. + */ +function inspect(PromiseInterface $promise) +{ + return Utils::inspect($promise); +} + +/** + * Waits on all of the provided promises, but does not unwrap rejected promises + * as thrown exception. + * + * Returns an array of inspection state arrays. + * + * @see inspect for the inspection state array format. + * + * @param PromiseInterface[] $promises Traversable of promises to wait upon. + * + * @return array + * + * @deprecated inspect will be removed in guzzlehttp/promises:2.0. Use Utils::inspectAll instead. + */ +function inspect_all($promises) +{ + return Utils::inspectAll($promises); +} + +/** + * Waits on all of the provided promises and returns the fulfilled values. + * + * Returns an array that contains the value of each promise (in the same order + * the promises were provided). An exception is thrown if any of the promises + * are rejected. + * + * @param iterable $promises Iterable of PromiseInterface objects to wait on. + * + * @return array + * + * @throws \Exception on error + * @throws \Throwable on error in PHP >=7 + * + * @deprecated unwrap will be removed in guzzlehttp/promises:2.0. Use Utils::unwrap instead. + */ +function unwrap($promises) +{ + return Utils::unwrap($promises); +} + +/** + * Given an array of promises, return a promise that is fulfilled when all the + * items in the array are fulfilled. + * + * The promise's fulfillment value is an array with fulfillment values at + * respective positions to the original array. If any promise in the array + * rejects, the returned promise is rejected with the rejection reason. + * + * @param mixed $promises Promises or values. + * @param bool $recursive If true, resolves new promises that might have been added to the stack during its own resolution. + * + * @return PromiseInterface + * + * @deprecated all will be removed in guzzlehttp/promises:2.0. Use Utils::all instead. + */ +function all($promises, $recursive = false) +{ + return Utils::all($promises, $recursive); +} + +/** + * Initiate a competitive race between multiple promises or values (values will + * become immediately fulfilled promises). + * + * When count amount of promises have been fulfilled, the returned promise is + * fulfilled with an array that contains the fulfillment values of the winners + * in order of resolution. + * + * This promise is rejected with a {@see AggregateException} if the number of + * fulfilled promises is less than the desired $count. + * + * @param int $count Total number of promises. + * @param mixed $promises Promises or values. + * + * @return PromiseInterface + * + * @deprecated some will be removed in guzzlehttp/promises:2.0. Use Utils::some instead. + */ +function some($count, $promises) +{ + return Utils::some($count, $promises); +} + +/** + * Like some(), with 1 as count. However, if the promise fulfills, the + * fulfillment value is not an array of 1 but the value directly. + * + * @param mixed $promises Promises or values. + * + * @return PromiseInterface + * + * @deprecated any will be removed in guzzlehttp/promises:2.0. Use Utils::any instead. + */ +function any($promises) +{ + return Utils::any($promises); +} + +/** + * Returns a promise that is fulfilled when all of the provided promises have + * been fulfilled or rejected. + * + * The returned promise is fulfilled with an array of inspection state arrays. + * + * @see inspect for the inspection state array format. + * + * @param mixed $promises Promises or values. + * + * @return PromiseInterface + * + * @deprecated settle will be removed in guzzlehttp/promises:2.0. Use Utils::settle instead. + */ +function settle($promises) +{ + return Utils::settle($promises); +} + +/** + * Given an iterator that yields promises or values, returns a promise that is + * fulfilled with a null value when the iterator has been consumed or the + * aggregate promise has been fulfilled or rejected. + * + * $onFulfilled is a function that accepts the fulfilled value, iterator index, + * and the aggregate promise. The callback can invoke any necessary side + * effects and choose to resolve or reject the aggregate if needed. + * + * $onRejected is a function that accepts the rejection reason, iterator index, + * and the aggregate promise. The callback can invoke any necessary side + * effects and choose to resolve or reject the aggregate if needed. + * + * @param mixed $iterable Iterator or array to iterate over. + * @param callable $onFulfilled + * @param callable $onRejected + * + * @return PromiseInterface + * + * @deprecated each will be removed in guzzlehttp/promises:2.0. Use Each::of instead. + */ +function each( + $iterable, + callable $onFulfilled = null, + callable $onRejected = null +) { + return Each::of($iterable, $onFulfilled, $onRejected); +} + +/** + * Like each, but only allows a certain number of outstanding promises at any + * given time. + * + * $concurrency may be an integer or a function that accepts the number of + * pending promises and returns a numeric concurrency limit value to allow for + * dynamic a concurrency size. + * + * @param mixed $iterable + * @param int|callable $concurrency + * @param callable $onFulfilled + * @param callable $onRejected + * + * @return PromiseInterface + * + * @deprecated each_limit will be removed in guzzlehttp/promises:2.0. Use Each::ofLimit instead. + */ +function each_limit( + $iterable, + $concurrency, + callable $onFulfilled = null, + callable $onRejected = null +) { + return Each::ofLimit($iterable, $concurrency, $onFulfilled, $onRejected); +} + +/** + * Like each_limit, but ensures that no promise in the given $iterable argument + * is rejected. If any promise is rejected, then the aggregate promise is + * rejected with the encountered rejection. + * + * @param mixed $iterable + * @param int|callable $concurrency + * @param callable $onFulfilled + * + * @return PromiseInterface + * + * @deprecated each_limit_all will be removed in guzzlehttp/promises:2.0. Use Each::ofLimitAll instead. + */ +function each_limit_all( + $iterable, + $concurrency, + callable $onFulfilled = null +) { + return Each::ofLimitAll($iterable, $concurrency, $onFulfilled); +} + +/** + * Returns true if a promise is fulfilled. + * + * @return bool + * + * @deprecated is_fulfilled will be removed in guzzlehttp/promises:2.0. Use Is::fulfilled instead. + */ +function is_fulfilled(PromiseInterface $promise) +{ + return Is::fulfilled($promise); +} + +/** + * Returns true if a promise is rejected. + * + * @return bool + * + * @deprecated is_rejected will be removed in guzzlehttp/promises:2.0. Use Is::rejected instead. + */ +function is_rejected(PromiseInterface $promise) +{ + return Is::rejected($promise); +} + +/** + * Returns true if a promise is fulfilled or rejected. + * + * @return bool + * + * @deprecated is_settled will be removed in guzzlehttp/promises:2.0. Use Is::settled instead. + */ +function is_settled(PromiseInterface $promise) +{ + return Is::settled($promise); +} + +/** + * Create a new coroutine. + * + * @see Coroutine + * + * @return PromiseInterface + * + * @deprecated coroutine will be removed in guzzlehttp/promises:2.0. Use Coroutine::of instead. + */ +function coroutine(callable $generatorFn) +{ + return Coroutine::of($generatorFn); +} diff --git a/lib/guzzlehttp/promises/src/functions_include.php b/lib/guzzlehttp/promises/src/functions_include.php new file mode 100644 index 00000000..34cd1710 --- /dev/null +++ b/lib/guzzlehttp/promises/src/functions_include.php @@ -0,0 +1,6 @@ +withPath('foo')->withHost('example.com')` will throw an exception + because the path of a URI with an authority must start with a slash "/" or be empty + - `(new Uri())->withScheme('http')` will return `'http://localhost'` + +### Deprecated + +- `Uri::resolve` in favor of `UriResolver::resolve` +- `Uri::removeDotSegments` in favor of `UriResolver::removeDotSegments` + +### Fixed + +- `Stream::read` when length parameter <= 0. +- `copy_to_stream` reads bytes in chunks instead of `maxLen` into memory. +- `ServerRequest::getUriFromGlobals` when `Host` header contains port. +- Compatibility of URIs with `file` scheme and empty host. + + +## [1.3.1] - 2016-06-25 + +### Fixed + +- `Uri::__toString` for network path references, e.g. `//example.org`. +- Missing lowercase normalization for host. +- Handling of URI components in case they are `'0'` in a lot of places, + e.g. as a user info password. +- `Uri::withAddedHeader` to correctly merge headers with different case. +- Trimming of header values in `Uri::withAddedHeader`. Header values may + be surrounded by whitespace which should be ignored according to RFC 7230 + Section 3.2.4. This does not apply to header names. +- `Uri::withAddedHeader` with an array of header values. +- `Uri::resolve` when base path has no slash and handling of fragment. +- Handling of encoding in `Uri::with(out)QueryValue` so one can pass the + key/value both in encoded as well as decoded form to those methods. This is + consistent with withPath, withQuery etc. +- `ServerRequest::withoutAttribute` when attribute value is null. + + +## [1.3.0] - 2016-04-13 + +### Added + +- Remaining interfaces needed for full PSR7 compatibility + (ServerRequestInterface, UploadedFileInterface, etc.). +- Support for stream_for from scalars. + +### Changed + +- Can now extend Uri. + +### Fixed +- A bug in validating request methods by making it more permissive. + + +## [1.2.3] - 2016-02-18 + +### Fixed + +- Support in `GuzzleHttp\Psr7\CachingStream` for seeking forward on remote + streams, which can sometimes return fewer bytes than requested with `fread`. +- Handling of gzipped responses with FNAME headers. + + +## [1.2.2] - 2016-01-22 + +### Added + +- Support for URIs without any authority. +- Support for HTTP 451 'Unavailable For Legal Reasons.' +- Support for using '0' as a filename. +- Support for including non-standard ports in Host headers. + + +## [1.2.1] - 2015-11-02 + +### Changes + +- Now supporting negative offsets when seeking to SEEK_END. + + +## [1.2.0] - 2015-08-15 + +### Changed + +- Body as `"0"` is now properly added to a response. +- Now allowing forward seeking in CachingStream. +- Now properly parsing HTTP requests that contain proxy targets in + `parse_request`. +- functions.php is now conditionally required. +- user-info is no longer dropped when resolving URIs. + + +## [1.1.0] - 2015-06-24 + +### Changed + +- URIs can now be relative. +- `multipart/form-data` headers are now overridden case-insensitively. +- URI paths no longer encode the following characters because they are allowed + in URIs: "(", ")", "*", "!", "'" +- A port is no longer added to a URI when the scheme is missing and no port is + present. + + +## 1.0.0 - 2015-05-19 + +Initial release. + +Currently unsupported: + +- `Psr\Http\Message\ServerRequestInterface` +- `Psr\Http\Message\UploadedFileInterface` + + + +[1.6.0]: https://github.com/guzzle/psr7/compare/1.5.2...1.6.0 +[1.5.2]: https://github.com/guzzle/psr7/compare/1.5.1...1.5.2 +[1.5.1]: https://github.com/guzzle/psr7/compare/1.5.0...1.5.1 +[1.5.0]: https://github.com/guzzle/psr7/compare/1.4.2...1.5.0 +[1.4.2]: https://github.com/guzzle/psr7/compare/1.4.1...1.4.2 +[1.4.1]: https://github.com/guzzle/psr7/compare/1.4.0...1.4.1 +[1.4.0]: https://github.com/guzzle/psr7/compare/1.3.1...1.4.0 +[1.3.1]: https://github.com/guzzle/psr7/compare/1.3.0...1.3.1 +[1.3.0]: https://github.com/guzzle/psr7/compare/1.2.3...1.3.0 +[1.2.3]: https://github.com/guzzle/psr7/compare/1.2.2...1.2.3 +[1.2.2]: https://github.com/guzzle/psr7/compare/1.2.1...1.2.2 +[1.2.1]: https://github.com/guzzle/psr7/compare/1.2.0...1.2.1 +[1.2.0]: https://github.com/guzzle/psr7/compare/1.1.0...1.2.0 +[1.1.0]: https://github.com/guzzle/psr7/compare/1.0.0...1.1.0 diff --git a/lib/guzzlehttp/psr7/LICENSE b/lib/guzzlehttp/psr7/LICENSE new file mode 100644 index 00000000..51c7ec81 --- /dev/null +++ b/lib/guzzlehttp/psr7/LICENSE @@ -0,0 +1,26 @@ +The MIT License (MIT) + +Copyright (c) 2015 Michael Dowling +Copyright (c) 2015 Márk Sági-Kazár +Copyright (c) 2015 Graham Campbell +Copyright (c) 2016 Tobias Schultze +Copyright (c) 2016 George Mponos +Copyright (c) 2018 Tobias Nyholm + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/lib/guzzlehttp/psr7/README.md b/lib/guzzlehttp/psr7/README.md new file mode 100644 index 00000000..ed81c927 --- /dev/null +++ b/lib/guzzlehttp/psr7/README.md @@ -0,0 +1,823 @@ +# PSR-7 Message Implementation + +This repository contains a full [PSR-7](http://www.php-fig.org/psr/psr-7/) +message implementation, several stream decorators, and some helpful +functionality like query string parsing. + +![CI](https://github.com/guzzle/psr7/workflows/CI/badge.svg) +![Static analysis](https://github.com/guzzle/psr7/workflows/Static%20analysis/badge.svg) + + +# Stream implementation + +This package comes with a number of stream implementations and stream +decorators. + + +## AppendStream + +`GuzzleHttp\Psr7\AppendStream` + +Reads from multiple streams, one after the other. + +```php +use GuzzleHttp\Psr7; + +$a = Psr7\Utils::streamFor('abc, '); +$b = Psr7\Utils::streamFor('123.'); +$composed = new Psr7\AppendStream([$a, $b]); + +$composed->addStream(Psr7\Utils::streamFor(' Above all listen to me')); + +echo $composed; // abc, 123. Above all listen to me. +``` + + +## BufferStream + +`GuzzleHttp\Psr7\BufferStream` + +Provides a buffer stream that can be written to fill a buffer, and read +from to remove bytes from the buffer. + +This stream returns a "hwm" metadata value that tells upstream consumers +what the configured high water mark of the stream is, or the maximum +preferred size of the buffer. + +```php +use GuzzleHttp\Psr7; + +// When more than 1024 bytes are in the buffer, it will begin returning +// false to writes. This is an indication that writers should slow down. +$buffer = new Psr7\BufferStream(1024); +``` + + +## CachingStream + +The CachingStream is used to allow seeking over previously read bytes on +non-seekable streams. This can be useful when transferring a non-seekable +entity body fails due to needing to rewind the stream (for example, resulting +from a redirect). Data that is read from the remote stream will be buffered in +a PHP temp stream so that previously read bytes are cached first in memory, +then on disk. + +```php +use GuzzleHttp\Psr7; + +$original = Psr7\Utils::streamFor(fopen('http://www.google.com', 'r')); +$stream = new Psr7\CachingStream($original); + +$stream->read(1024); +echo $stream->tell(); +// 1024 + +$stream->seek(0); +echo $stream->tell(); +// 0 +``` + + +## DroppingStream + +`GuzzleHttp\Psr7\DroppingStream` + +Stream decorator that begins dropping data once the size of the underlying +stream becomes too full. + +```php +use GuzzleHttp\Psr7; + +// Create an empty stream +$stream = Psr7\Utils::streamFor(); + +// Start dropping data when the stream has more than 10 bytes +$dropping = new Psr7\DroppingStream($stream, 10); + +$dropping->write('01234567890123456789'); +echo $stream; // 0123456789 +``` + + +## FnStream + +`GuzzleHttp\Psr7\FnStream` + +Compose stream implementations based on a hash of functions. + +Allows for easy testing and extension of a provided stream without needing +to create a concrete class for a simple extension point. + +```php + +use GuzzleHttp\Psr7; + +$stream = Psr7\Utils::streamFor('hi'); +$fnStream = Psr7\FnStream::decorate($stream, [ + 'rewind' => function () use ($stream) { + echo 'About to rewind - '; + $stream->rewind(); + echo 'rewound!'; + } +]); + +$fnStream->rewind(); +// Outputs: About to rewind - rewound! +``` + + +## InflateStream + +`GuzzleHttp\Psr7\InflateStream` + +Uses PHP's zlib.inflate filter to inflate zlib (HTTP deflate, RFC1950) or gzipped (RFC1952) content. + +This stream decorator converts the provided stream to a PHP stream resource, +then appends the zlib.inflate filter. The stream is then converted back +to a Guzzle stream resource to be used as a Guzzle stream. + + +## LazyOpenStream + +`GuzzleHttp\Psr7\LazyOpenStream` + +Lazily reads or writes to a file that is opened only after an IO operation +take place on the stream. + +```php +use GuzzleHttp\Psr7; + +$stream = new Psr7\LazyOpenStream('/path/to/file', 'r'); +// The file has not yet been opened... + +echo $stream->read(10); +// The file is opened and read from only when needed. +``` + + +## LimitStream + +`GuzzleHttp\Psr7\LimitStream` + +LimitStream can be used to read a subset or slice of an existing stream object. +This can be useful for breaking a large file into smaller pieces to be sent in +chunks (e.g. Amazon S3's multipart upload API). + +```php +use GuzzleHttp\Psr7; + +$original = Psr7\Utils::streamFor(fopen('/tmp/test.txt', 'r+')); +echo $original->getSize(); +// >>> 1048576 + +// Limit the size of the body to 1024 bytes and start reading from byte 2048 +$stream = new Psr7\LimitStream($original, 1024, 2048); +echo $stream->getSize(); +// >>> 1024 +echo $stream->tell(); +// >>> 0 +``` + + +## MultipartStream + +`GuzzleHttp\Psr7\MultipartStream` + +Stream that when read returns bytes for a streaming multipart or +multipart/form-data stream. + + +## NoSeekStream + +`GuzzleHttp\Psr7\NoSeekStream` + +NoSeekStream wraps a stream and does not allow seeking. + +```php +use GuzzleHttp\Psr7; + +$original = Psr7\Utils::streamFor('foo'); +$noSeek = new Psr7\NoSeekStream($original); + +echo $noSeek->read(3); +// foo +var_export($noSeek->isSeekable()); +// false +$noSeek->seek(0); +var_export($noSeek->read(3)); +// NULL +``` + + +## PumpStream + +`GuzzleHttp\Psr7\PumpStream` + +Provides a read only stream that pumps data from a PHP callable. + +When invoking the provided callable, the PumpStream will pass the amount of +data requested to read to the callable. The callable can choose to ignore +this value and return fewer or more bytes than requested. Any extra data +returned by the provided callable is buffered internally until drained using +the read() function of the PumpStream. The provided callable MUST return +false when there is no more data to read. + + +## Implementing stream decorators + +Creating a stream decorator is very easy thanks to the +`GuzzleHttp\Psr7\StreamDecoratorTrait`. This trait provides methods that +implement `Psr\Http\Message\StreamInterface` by proxying to an underlying +stream. Just `use` the `StreamDecoratorTrait` and implement your custom +methods. + +For example, let's say we wanted to call a specific function each time the last +byte is read from a stream. This could be implemented by overriding the +`read()` method. + +```php +use Psr\Http\Message\StreamInterface; +use GuzzleHttp\Psr7\StreamDecoratorTrait; + +class EofCallbackStream implements StreamInterface +{ + use StreamDecoratorTrait; + + private $callback; + + public function __construct(StreamInterface $stream, callable $cb) + { + $this->stream = $stream; + $this->callback = $cb; + } + + public function read($length) + { + $result = $this->stream->read($length); + + // Invoke the callback when EOF is hit. + if ($this->eof()) { + call_user_func($this->callback); + } + + return $result; + } +} +``` + +This decorator could be added to any existing stream and used like so: + +```php +use GuzzleHttp\Psr7; + +$original = Psr7\Utils::streamFor('foo'); + +$eofStream = new EofCallbackStream($original, function () { + echo 'EOF!'; +}); + +$eofStream->read(2); +$eofStream->read(1); +// echoes "EOF!" +$eofStream->seek(0); +$eofStream->read(3); +// echoes "EOF!" +``` + + +## PHP StreamWrapper + +You can use the `GuzzleHttp\Psr7\StreamWrapper` class if you need to use a +PSR-7 stream as a PHP stream resource. + +Use the `GuzzleHttp\Psr7\StreamWrapper::getResource()` method to create a PHP +stream from a PSR-7 stream. + +```php +use GuzzleHttp\Psr7\StreamWrapper; + +$stream = GuzzleHttp\Psr7\Utils::streamFor('hello!'); +$resource = StreamWrapper::getResource($stream); +echo fread($resource, 6); // outputs hello! +``` + + +# Static API + +There are various static methods available under the `GuzzleHttp\Psr7` namespace. + + +## `GuzzleHttp\Psr7\Message::toString` + +`public static function toString(MessageInterface $message): string` + +Returns the string representation of an HTTP message. + +```php +$request = new GuzzleHttp\Psr7\Request('GET', 'http://example.com'); +echo GuzzleHttp\Psr7\Message::toString($request); +``` + + +## `GuzzleHttp\Psr7\Message::bodySummary` + +`public static function bodySummary(MessageInterface $message, int $truncateAt = 120): string|null` + +Get a short summary of the message body. + +Will return `null` if the response is not printable. + + +## `GuzzleHttp\Psr7\Message::rewindBody` + +`public static function rewindBody(MessageInterface $message): void` + +Attempts to rewind a message body and throws an exception on failure. + +The body of the message will only be rewound if a call to `tell()` +returns a value other than `0`. + + +## `GuzzleHttp\Psr7\Message::parseMessage` + +`public static function parseMessage(string $message): array` + +Parses an HTTP message into an associative array. + +The array contains the "start-line" key containing the start line of +the message, "headers" key containing an associative array of header +array values, and a "body" key containing the body of the message. + + +## `GuzzleHttp\Psr7\Message::parseRequestUri` + +`public static function parseRequestUri(string $path, array $headers): string` + +Constructs a URI for an HTTP request message. + + +## `GuzzleHttp\Psr7\Message::parseRequest` + +`public static function parseRequest(string $message): Request` + +Parses a request message string into a request object. + + +## `GuzzleHttp\Psr7\Message::parseResponse` + +`public static function parseResponse(string $message): Response` + +Parses a response message string into a response object. + + +## `GuzzleHttp\Psr7\Header::parse` + +`public static function parse(string|array $header): array` + +Parse an array of header values containing ";" separated data into an +array of associative arrays representing the header key value pair data +of the header. When a parameter does not contain a value, but just +contains a key, this function will inject a key with a '' string value. + + +## `GuzzleHttp\Psr7\Header::normalize` + +`public static function normalize(string|array $header): array` + +Converts an array of header values that may contain comma separated +headers into an array of headers with no comma separated values. + + +## `GuzzleHttp\Psr7\Query::parse` + +`public static function parse(string $str, int|bool $urlEncoding = true): array` + +Parse a query string into an associative array. + +If multiple values are found for the same key, the value of that key +value pair will become an array. This function does not parse nested +PHP style arrays into an associative array (e.g., `foo[a]=1&foo[b]=2` +will be parsed into `['foo[a]' => '1', 'foo[b]' => '2'])`. + + +## `GuzzleHttp\Psr7\Query::build` + +`public static function build(array $params, int|false $encoding = PHP_QUERY_RFC3986): string` + +Build a query string from an array of key value pairs. + +This function can use the return value of `parse()` to build a query +string. This function does not modify the provided keys when an array is +encountered (like `http_build_query()` would). + + +## `GuzzleHttp\Psr7\Utils::caselessRemove` + +`public static function caselessRemove(iterable $keys, $keys, array $data): array` + +Remove the items given by the keys, case insensitively from the data. + + +## `GuzzleHttp\Psr7\Utils::copyToStream` + +`public static function copyToStream(StreamInterface $source, StreamInterface $dest, int $maxLen = -1): void` + +Copy the contents of a stream into another stream until the given number +of bytes have been read. + + +## `GuzzleHttp\Psr7\Utils::copyToString` + +`public static function copyToString(StreamInterface $stream, int $maxLen = -1): string` + +Copy the contents of a stream into a string until the given number of +bytes have been read. + + +## `GuzzleHttp\Psr7\Utils::hash` + +`public static function hash(StreamInterface $stream, string $algo, bool $rawOutput = false): string` + +Calculate a hash of a stream. + +This method reads the entire stream to calculate a rolling hash, based on +PHP's `hash_init` functions. + + +## `GuzzleHttp\Psr7\Utils::modifyRequest` + +`public static function modifyRequest(RequestInterface $request, array $changes): RequestInterface` + +Clone and modify a request with the given changes. + +This method is useful for reducing the number of clones needed to mutate +a message. + +- method: (string) Changes the HTTP method. +- set_headers: (array) Sets the given headers. +- remove_headers: (array) Remove the given headers. +- body: (mixed) Sets the given body. +- uri: (UriInterface) Set the URI. +- query: (string) Set the query string value of the URI. +- version: (string) Set the protocol version. + + +## `GuzzleHttp\Psr7\Utils::readLine` + +`public static function readLine(StreamInterface $stream, int $maxLength = null): string` + +Read a line from the stream up to the maximum allowed buffer length. + + +## `GuzzleHttp\Psr7\Utils::streamFor` + +`public static function streamFor(resource|string|null|int|float|bool|StreamInterface|callable|\Iterator $resource = '', array $options = []): StreamInterface` + +Create a new stream based on the input type. + +Options is an associative array that can contain the following keys: + +- metadata: Array of custom metadata. +- size: Size of the stream. + +This method accepts the following `$resource` types: + +- `Psr\Http\Message\StreamInterface`: Returns the value as-is. +- `string`: Creates a stream object that uses the given string as the contents. +- `resource`: Creates a stream object that wraps the given PHP stream resource. +- `Iterator`: If the provided value implements `Iterator`, then a read-only + stream object will be created that wraps the given iterable. Each time the + stream is read from, data from the iterator will fill a buffer and will be + continuously called until the buffer is equal to the requested read size. + Subsequent read calls will first read from the buffer and then call `next` + on the underlying iterator until it is exhausted. +- `object` with `__toString()`: If the object has the `__toString()` method, + the object will be cast to a string and then a stream will be returned that + uses the string value. +- `NULL`: When `null` is passed, an empty stream object is returned. +- `callable` When a callable is passed, a read-only stream object will be + created that invokes the given callable. The callable is invoked with the + number of suggested bytes to read. The callable can return any number of + bytes, but MUST return `false` when there is no more data to return. The + stream object that wraps the callable will invoke the callable until the + number of requested bytes are available. Any additional bytes will be + buffered and used in subsequent reads. + +```php +$stream = GuzzleHttp\Psr7\Utils::streamFor('foo'); +$stream = GuzzleHttp\Psr7\Utils::streamFor(fopen('/path/to/file', 'r')); + +$generator = function ($bytes) { + for ($i = 0; $i < $bytes; $i++) { + yield ' '; + } +} + +$stream = GuzzleHttp\Psr7\Utils::streamFor($generator(100)); +``` + + +## `GuzzleHttp\Psr7\Utils::tryFopen` + +`public static function tryFopen(string $filename, string $mode): resource` + +Safely opens a PHP stream resource using a filename. + +When fopen fails, PHP normally raises a warning. This function adds an +error handler that checks for errors and throws an exception instead. + + +## `GuzzleHttp\Psr7\Utils::uriFor` + +`public static function uriFor(string|UriInterface $uri): UriInterface` + +Returns a UriInterface for the given value. + +This function accepts a string or UriInterface and returns a +UriInterface for the given value. If the value is already a +UriInterface, it is returned as-is. + + +## `GuzzleHttp\Psr7\MimeType::fromFilename` + +`public static function fromFilename(string $filename): string|null` + +Determines the mimetype of a file by looking at its extension. + + +## `GuzzleHttp\Psr7\MimeType::fromExtension` + +`public static function fromExtension(string $extension): string|null` + +Maps a file extensions to a mimetype. + + +## Upgrading from Function API + +The static API was first introduced in 1.7.0, in order to mitigate problems with functions conflicting between global and local copies of the package. The function API was removed in 2.0.0. A migration table has been provided here for your convenience: + +| Original Function | Replacement Method | +|----------------|----------------| +| `str` | `Message::toString` | +| `uri_for` | `Utils::uriFor` | +| `stream_for` | `Utils::streamFor` | +| `parse_header` | `Header::parse` | +| `normalize_header` | `Header::normalize` | +| `modify_request` | `Utils::modifyRequest` | +| `rewind_body` | `Message::rewindBody` | +| `try_fopen` | `Utils::tryFopen` | +| `copy_to_string` | `Utils::copyToString` | +| `copy_to_stream` | `Utils::copyToStream` | +| `hash` | `Utils::hash` | +| `readline` | `Utils::readLine` | +| `parse_request` | `Message::parseRequest` | +| `parse_response` | `Message::parseResponse` | +| `parse_query` | `Query::parse` | +| `build_query` | `Query::build` | +| `mimetype_from_filename` | `MimeType::fromFilename` | +| `mimetype_from_extension` | `MimeType::fromExtension` | +| `_parse_message` | `Message::parseMessage` | +| `_parse_request_uri` | `Message::parseRequestUri` | +| `get_message_body_summary` | `Message::bodySummary` | +| `_caseless_remove` | `Utils::caselessRemove` | + + +# Additional URI Methods + +Aside from the standard `Psr\Http\Message\UriInterface` implementation in form of the `GuzzleHttp\Psr7\Uri` class, +this library also provides additional functionality when working with URIs as static methods. + +## URI Types + +An instance of `Psr\Http\Message\UriInterface` can either be an absolute URI or a relative reference. +An absolute URI has a scheme. A relative reference is used to express a URI relative to another URI, +the base URI. Relative references can be divided into several forms according to +[RFC 3986 Section 4.2](https://tools.ietf.org/html/rfc3986#section-4.2): + +- network-path references, e.g. `//example.com/path` +- absolute-path references, e.g. `/path` +- relative-path references, e.g. `subpath` + +The following methods can be used to identify the type of the URI. + +### `GuzzleHttp\Psr7\Uri::isAbsolute` + +`public static function isAbsolute(UriInterface $uri): bool` + +Whether the URI is absolute, i.e. it has a scheme. + +### `GuzzleHttp\Psr7\Uri::isNetworkPathReference` + +`public static function isNetworkPathReference(UriInterface $uri): bool` + +Whether the URI is a network-path reference. A relative reference that begins with two slash characters is +termed an network-path reference. + +### `GuzzleHttp\Psr7\Uri::isAbsolutePathReference` + +`public static function isAbsolutePathReference(UriInterface $uri): bool` + +Whether the URI is a absolute-path reference. A relative reference that begins with a single slash character is +termed an absolute-path reference. + +### `GuzzleHttp\Psr7\Uri::isRelativePathReference` + +`public static function isRelativePathReference(UriInterface $uri): bool` + +Whether the URI is a relative-path reference. A relative reference that does not begin with a slash character is +termed a relative-path reference. + +### `GuzzleHttp\Psr7\Uri::isSameDocumentReference` + +`public static function isSameDocumentReference(UriInterface $uri, UriInterface $base = null): bool` + +Whether the URI is a same-document reference. A same-document reference refers to a URI that is, aside from its +fragment component, identical to the base URI. When no base URI is given, only an empty URI reference +(apart from its fragment) is considered a same-document reference. + +## URI Components + +Additional methods to work with URI components. + +### `GuzzleHttp\Psr7\Uri::isDefaultPort` + +`public static function isDefaultPort(UriInterface $uri): bool` + +Whether the URI has the default port of the current scheme. `Psr\Http\Message\UriInterface::getPort` may return null +or the standard port. This method can be used independently of the implementation. + +### `GuzzleHttp\Psr7\Uri::composeComponents` + +`public static function composeComponents($scheme, $authority, $path, $query, $fragment): string` + +Composes a URI reference string from its various components according to +[RFC 3986 Section 5.3](https://tools.ietf.org/html/rfc3986#section-5.3). Usually this method does not need to be called +manually but instead is used indirectly via `Psr\Http\Message\UriInterface::__toString`. + +### `GuzzleHttp\Psr7\Uri::fromParts` + +`public static function fromParts(array $parts): UriInterface` + +Creates a URI from a hash of [`parse_url`](http://php.net/manual/en/function.parse-url.php) components. + + +### `GuzzleHttp\Psr7\Uri::withQueryValue` + +`public static function withQueryValue(UriInterface $uri, $key, $value): UriInterface` + +Creates a new URI with a specific query string value. Any existing query string values that exactly match the +provided key are removed and replaced with the given key value pair. A value of null will set the query string +key without a value, e.g. "key" instead of "key=value". + +### `GuzzleHttp\Psr7\Uri::withQueryValues` + +`public static function withQueryValues(UriInterface $uri, array $keyValueArray): UriInterface` + +Creates a new URI with multiple query string values. It has the same behavior as `withQueryValue()` but for an +associative array of key => value. + +### `GuzzleHttp\Psr7\Uri::withoutQueryValue` + +`public static function withoutQueryValue(UriInterface $uri, $key): UriInterface` + +Creates a new URI with a specific query string value removed. Any existing query string values that exactly match the +provided key are removed. + +## Reference Resolution + +`GuzzleHttp\Psr7\UriResolver` provides methods to resolve a URI reference in the context of a base URI according +to [RFC 3986 Section 5](https://tools.ietf.org/html/rfc3986#section-5). This is for example also what web browsers +do when resolving a link in a website based on the current request URI. + +### `GuzzleHttp\Psr7\UriResolver::resolve` + +`public static function resolve(UriInterface $base, UriInterface $rel): UriInterface` + +Converts the relative URI into a new URI that is resolved against the base URI. + +### `GuzzleHttp\Psr7\UriResolver::removeDotSegments` + +`public static function removeDotSegments(string $path): string` + +Removes dot segments from a path and returns the new path according to +[RFC 3986 Section 5.2.4](https://tools.ietf.org/html/rfc3986#section-5.2.4). + +### `GuzzleHttp\Psr7\UriResolver::relativize` + +`public static function relativize(UriInterface $base, UriInterface $target): UriInterface` + +Returns the target URI as a relative reference from the base URI. This method is the counterpart to resolve(): + +```php +(string) $target === (string) UriResolver::resolve($base, UriResolver::relativize($base, $target)) +``` + +One use-case is to use the current request URI as base URI and then generate relative links in your documents +to reduce the document size or offer self-contained downloadable document archives. + +```php +$base = new Uri('http://example.com/a/b/'); +echo UriResolver::relativize($base, new Uri('http://example.com/a/b/c')); // prints 'c'. +echo UriResolver::relativize($base, new Uri('http://example.com/a/x/y')); // prints '../x/y'. +echo UriResolver::relativize($base, new Uri('http://example.com/a/b/?q')); // prints '?q'. +echo UriResolver::relativize($base, new Uri('http://example.org/a/b/')); // prints '//example.org/a/b/'. +``` + +## Normalization and Comparison + +`GuzzleHttp\Psr7\UriNormalizer` provides methods to normalize and compare URIs according to +[RFC 3986 Section 6](https://tools.ietf.org/html/rfc3986#section-6). + +### `GuzzleHttp\Psr7\UriNormalizer::normalize` + +`public static function normalize(UriInterface $uri, $flags = self::PRESERVING_NORMALIZATIONS): UriInterface` + +Returns a normalized URI. The scheme and host component are already normalized to lowercase per PSR-7 UriInterface. +This methods adds additional normalizations that can be configured with the `$flags` parameter which is a bitmask +of normalizations to apply. The following normalizations are available: + +- `UriNormalizer::PRESERVING_NORMALIZATIONS` + + Default normalizations which only include the ones that preserve semantics. + +- `UriNormalizer::CAPITALIZE_PERCENT_ENCODING` + + All letters within a percent-encoding triplet (e.g., "%3A") are case-insensitive, and should be capitalized. + + Example: `http://example.org/a%c2%b1b` → `http://example.org/a%C2%B1b` + +- `UriNormalizer::DECODE_UNRESERVED_CHARACTERS` + + Decodes percent-encoded octets of unreserved characters. For consistency, percent-encoded octets in the ranges of + ALPHA (%41–%5A and %61–%7A), DIGIT (%30–%39), hyphen (%2D), period (%2E), underscore (%5F), or tilde (%7E) should + not be created by URI producers and, when found in a URI, should be decoded to their corresponding unreserved + characters by URI normalizers. + + Example: `http://example.org/%7Eusern%61me/` → `http://example.org/~username/` + +- `UriNormalizer::CONVERT_EMPTY_PATH` + + Converts the empty path to "/" for http and https URIs. + + Example: `http://example.org` → `http://example.org/` + +- `UriNormalizer::REMOVE_DEFAULT_HOST` + + Removes the default host of the given URI scheme from the URI. Only the "file" scheme defines the default host + "localhost". All of `file:/myfile`, `file:///myfile`, and `file://localhost/myfile` are equivalent according to + RFC 3986. + + Example: `file://localhost/myfile` → `file:///myfile` + +- `UriNormalizer::REMOVE_DEFAULT_PORT` + + Removes the default port of the given URI scheme from the URI. + + Example: `http://example.org:80/` → `http://example.org/` + +- `UriNormalizer::REMOVE_DOT_SEGMENTS` + + Removes unnecessary dot-segments. Dot-segments in relative-path references are not removed as it would + change the semantics of the URI reference. + + Example: `http://example.org/../a/b/../c/./d.html` → `http://example.org/a/c/d.html` + +- `UriNormalizer::REMOVE_DUPLICATE_SLASHES` + + Paths which include two or more adjacent slashes are converted to one. Webservers usually ignore duplicate slashes + and treat those URIs equivalent. But in theory those URIs do not need to be equivalent. So this normalization + may change the semantics. Encoded slashes (%2F) are not removed. + + Example: `http://example.org//foo///bar.html` → `http://example.org/foo/bar.html` + +- `UriNormalizer::SORT_QUERY_PARAMETERS` + + Sort query parameters with their values in alphabetical order. However, the order of parameters in a URI may be + significant (this is not defined by the standard). So this normalization is not safe and may change the semantics + of the URI. + + Example: `?lang=en&article=fred` → `?article=fred&lang=en` + +### `GuzzleHttp\Psr7\UriNormalizer::isEquivalent` + +`public static function isEquivalent(UriInterface $uri1, UriInterface $uri2, $normalizations = self::PRESERVING_NORMALIZATIONS): bool` + +Whether two URIs can be considered equivalent. Both URIs are normalized automatically before comparison with the given +`$normalizations` bitmask. The method also accepts relative URI references and returns true when they are equivalent. +This of course assumes they will be resolved against the same base URI. If this is not the case, determination of +equivalence or difference of relative references does not mean anything. + + +## Security + +If you discover a security vulnerability within this package, please send an email to security@tidelift.com. All security vulnerabilities will be promptly addressed. Please do not disclose security-related issues publicly until a fix has been announced. Please see [Security Policy](https://github.com/guzzle/psr7/security/policy) for more information. + +## License + +Guzzle is made available under the MIT License (MIT). Please see [License File](LICENSE) for more information. + +## For Enterprise + +Available as part of the Tidelift Subscription + +The maintainers of Guzzle and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. [Learn more.](https://tidelift.com/subscription/pkg/packagist-guzzlehttp-psr7?utm_source=packagist-guzzlehttp-psr7&utm_medium=referral&utm_campaign=enterprise&utm_term=repo) diff --git a/lib/guzzlehttp/psr7/composer.json b/lib/guzzlehttp/psr7/composer.json new file mode 100644 index 00000000..885aa1da --- /dev/null +++ b/lib/guzzlehttp/psr7/composer.json @@ -0,0 +1,89 @@ +{ + "name": "guzzlehttp/psr7", + "description": "PSR-7 message implementation that also provides common utility methods", + "keywords": [ + "request", + "response", + "message", + "stream", + "http", + "uri", + "url", + "psr-7" + ], + "license": "MIT", + "authors": [ + { + "name": "Graham Campbell", + "email": "hello@gjcampbell.co.uk", + "homepage": "https://github.com/GrahamCampbell" + }, + { + "name": "Michael Dowling", + "email": "mtdowling@gmail.com", + "homepage": "https://github.com/mtdowling" + }, + { + "name": "George Mponos", + "email": "gmponos@gmail.com", + "homepage": "https://github.com/gmponos" + }, + { + "name": "Tobias Nyholm", + "email": "tobias.nyholm@gmail.com", + "homepage": "https://github.com/Nyholm" + }, + { + "name": "Márk Sági-Kazár", + "email": "mark.sagikazar@gmail.com", + "homepage": "https://github.com/sagikazarmark" + }, + { + "name": "Tobias Schultze", + "email": "webmaster@tubo-world.de", + "homepage": "https://github.com/Tobion" + }, + { + "name": "Márk Sági-Kazár", + "email": "mark.sagikazar@gmail.com", + "homepage": "https://sagikazarmark.hu" + } + ], + "require": { + "php": "^7.2.5 || ^8.0", + "psr/http-factory": "^1.0", + "psr/http-message": "^1.0", + "ralouphie/getallheaders": "^3.0" + }, + "provide": { + "psr/http-factory-implementation": "1.0", + "psr/http-message-implementation": "1.0" + }, + "require-dev": { + "bamarni/composer-bin-plugin": "^1.4.1", + "http-interop/http-factory-tests": "^0.9", + "phpunit/phpunit": "^8.5.8 || ^9.3.10" + }, + "suggest": { + "laminas/laminas-httphandlerrunner": "Emit PSR-7 responses" + }, + "autoload": { + "psr-4": { + "GuzzleHttp\\Psr7\\": "src/" + } + }, + "autoload-dev": { + "psr-4": { + "GuzzleHttp\\Tests\\Psr7\\": "tests/" + } + }, + "extra": { + "branch-alias": { + "dev-master": "2.1-dev" + } + }, + "config": { + "preferred-install": "dist", + "sort-packages": true + } +} diff --git a/lib/guzzlehttp/psr7/src/AppendStream.php b/lib/guzzlehttp/psr7/src/AppendStream.php new file mode 100644 index 00000000..967925f3 --- /dev/null +++ b/lib/guzzlehttp/psr7/src/AppendStream.php @@ -0,0 +1,249 @@ +addStream($stream); + } + } + + public function __toString(): string + { + try { + $this->rewind(); + return $this->getContents(); + } catch (\Throwable $e) { + if (\PHP_VERSION_ID >= 70400) { + throw $e; + } + trigger_error(sprintf('%s::__toString exception: %s', self::class, (string) $e), E_USER_ERROR); + return ''; + } + } + + /** + * Add a stream to the AppendStream + * + * @param StreamInterface $stream Stream to append. Must be readable. + * + * @throws \InvalidArgumentException if the stream is not readable + */ + public function addStream(StreamInterface $stream): void + { + if (!$stream->isReadable()) { + throw new \InvalidArgumentException('Each stream must be readable'); + } + + // The stream is only seekable if all streams are seekable + if (!$stream->isSeekable()) { + $this->seekable = false; + } + + $this->streams[] = $stream; + } + + public function getContents(): string + { + return Utils::copyToString($this); + } + + /** + * Closes each attached stream. + */ + public function close(): void + { + $this->pos = $this->current = 0; + $this->seekable = true; + + foreach ($this->streams as $stream) { + $stream->close(); + } + + $this->streams = []; + } + + /** + * Detaches each attached stream. + * + * Returns null as it's not clear which underlying stream resource to return. + */ + public function detach() + { + $this->pos = $this->current = 0; + $this->seekable = true; + + foreach ($this->streams as $stream) { + $stream->detach(); + } + + $this->streams = []; + + return null; + } + + public function tell(): int + { + return $this->pos; + } + + /** + * Tries to calculate the size by adding the size of each stream. + * + * If any of the streams do not return a valid number, then the size of the + * append stream cannot be determined and null is returned. + */ + public function getSize(): ?int + { + $size = 0; + + foreach ($this->streams as $stream) { + $s = $stream->getSize(); + if ($s === null) { + return null; + } + $size += $s; + } + + return $size; + } + + public function eof(): bool + { + return !$this->streams || + ($this->current >= count($this->streams) - 1 && + $this->streams[$this->current]->eof()); + } + + public function rewind(): void + { + $this->seek(0); + } + + /** + * Attempts to seek to the given position. Only supports SEEK_SET. + */ + public function seek($offset, $whence = SEEK_SET): void + { + if (!$this->seekable) { + throw new \RuntimeException('This AppendStream is not seekable'); + } elseif ($whence !== SEEK_SET) { + throw new \RuntimeException('The AppendStream can only seek with SEEK_SET'); + } + + $this->pos = $this->current = 0; + + // Rewind each stream + foreach ($this->streams as $i => $stream) { + try { + $stream->rewind(); + } catch (\Exception $e) { + throw new \RuntimeException('Unable to seek stream ' + . $i . ' of the AppendStream', 0, $e); + } + } + + // Seek to the actual position by reading from each stream + while ($this->pos < $offset && !$this->eof()) { + $result = $this->read(min(8096, $offset - $this->pos)); + if ($result === '') { + break; + } + } + } + + /** + * Reads from all of the appended streams until the length is met or EOF. + */ + public function read($length): string + { + $buffer = ''; + $total = count($this->streams) - 1; + $remaining = $length; + $progressToNext = false; + + while ($remaining > 0) { + + // Progress to the next stream if needed. + if ($progressToNext || $this->streams[$this->current]->eof()) { + $progressToNext = false; + if ($this->current === $total) { + break; + } + $this->current++; + } + + $result = $this->streams[$this->current]->read($remaining); + + if ($result === '') { + $progressToNext = true; + continue; + } + + $buffer .= $result; + $remaining = $length - strlen($buffer); + } + + $this->pos += strlen($buffer); + + return $buffer; + } + + public function isReadable(): bool + { + return true; + } + + public function isWritable(): bool + { + return false; + } + + public function isSeekable(): bool + { + return $this->seekable; + } + + public function write($string): int + { + throw new \RuntimeException('Cannot write to an AppendStream'); + } + + /** + * {@inheritdoc} + * + * @return mixed + */ + public function getMetadata($key = null) + { + return $key ? null : []; + } +} diff --git a/lib/guzzlehttp/psr7/src/BufferStream.php b/lib/guzzlehttp/psr7/src/BufferStream.php new file mode 100644 index 00000000..21be8c0a --- /dev/null +++ b/lib/guzzlehttp/psr7/src/BufferStream.php @@ -0,0 +1,149 @@ +hwm = $hwm; + } + + public function __toString(): string + { + return $this->getContents(); + } + + public function getContents(): string + { + $buffer = $this->buffer; + $this->buffer = ''; + + return $buffer; + } + + public function close(): void + { + $this->buffer = ''; + } + + public function detach() + { + $this->close(); + + return null; + } + + public function getSize(): ?int + { + return strlen($this->buffer); + } + + public function isReadable(): bool + { + return true; + } + + public function isWritable(): bool + { + return true; + } + + public function isSeekable(): bool + { + return false; + } + + public function rewind(): void + { + $this->seek(0); + } + + public function seek($offset, $whence = SEEK_SET): void + { + throw new \RuntimeException('Cannot seek a BufferStream'); + } + + public function eof(): bool + { + return strlen($this->buffer) === 0; + } + + public function tell(): int + { + throw new \RuntimeException('Cannot determine the position of a BufferStream'); + } + + /** + * Reads data from the buffer. + */ + public function read($length): string + { + $currentLength = strlen($this->buffer); + + if ($length >= $currentLength) { + // No need to slice the buffer because we don't have enough data. + $result = $this->buffer; + $this->buffer = ''; + } else { + // Slice up the result to provide a subset of the buffer. + $result = substr($this->buffer, 0, $length); + $this->buffer = substr($this->buffer, $length); + } + + return $result; + } + + /** + * Writes data to the buffer. + */ + public function write($string): int + { + $this->buffer .= $string; + + if (strlen($this->buffer) >= $this->hwm) { + return 0; + } + + return strlen($string); + } + + /** + * {@inheritdoc} + * + * @return mixed + */ + public function getMetadata($key = null) + { + if ($key === 'hwm') { + return $this->hwm; + } + + return $key ? null : []; + } +} diff --git a/lib/guzzlehttp/psr7/src/CachingStream.php b/lib/guzzlehttp/psr7/src/CachingStream.php new file mode 100644 index 00000000..7a70ee94 --- /dev/null +++ b/lib/guzzlehttp/psr7/src/CachingStream.php @@ -0,0 +1,148 @@ +remoteStream = $stream; + $this->stream = $target ?: new Stream(Utils::tryFopen('php://temp', 'r+')); + } + + public function getSize(): ?int + { + $remoteSize = $this->remoteStream->getSize(); + + if (null === $remoteSize) { + return null; + } + + return max($this->stream->getSize(), $remoteSize); + } + + public function rewind(): void + { + $this->seek(0); + } + + public function seek($offset, $whence = SEEK_SET): void + { + if ($whence === SEEK_SET) { + $byte = $offset; + } elseif ($whence === SEEK_CUR) { + $byte = $offset + $this->tell(); + } elseif ($whence === SEEK_END) { + $size = $this->remoteStream->getSize(); + if ($size === null) { + $size = $this->cacheEntireStream(); + } + $byte = $size + $offset; + } else { + throw new \InvalidArgumentException('Invalid whence'); + } + + $diff = $byte - $this->stream->getSize(); + + if ($diff > 0) { + // Read the remoteStream until we have read in at least the amount + // of bytes requested, or we reach the end of the file. + while ($diff > 0 && !$this->remoteStream->eof()) { + $this->read($diff); + $diff = $byte - $this->stream->getSize(); + } + } else { + // We can just do a normal seek since we've already seen this byte. + $this->stream->seek($byte); + } + } + + public function read($length): string + { + // Perform a regular read on any previously read data from the buffer + $data = $this->stream->read($length); + $remaining = $length - strlen($data); + + // More data was requested so read from the remote stream + if ($remaining) { + // If data was written to the buffer in a position that would have + // been filled from the remote stream, then we must skip bytes on + // the remote stream to emulate overwriting bytes from that + // position. This mimics the behavior of other PHP stream wrappers. + $remoteData = $this->remoteStream->read( + $remaining + $this->skipReadBytes + ); + + if ($this->skipReadBytes) { + $len = strlen($remoteData); + $remoteData = substr($remoteData, $this->skipReadBytes); + $this->skipReadBytes = max(0, $this->skipReadBytes - $len); + } + + $data .= $remoteData; + $this->stream->write($remoteData); + } + + return $data; + } + + public function write($string): int + { + // When appending to the end of the currently read stream, you'll want + // to skip bytes from being read from the remote stream to emulate + // other stream wrappers. Basically replacing bytes of data of a fixed + // length. + $overflow = (strlen($string) + $this->tell()) - $this->remoteStream->tell(); + if ($overflow > 0) { + $this->skipReadBytes += $overflow; + } + + return $this->stream->write($string); + } + + public function eof(): bool + { + return $this->stream->eof() && $this->remoteStream->eof(); + } + + /** + * Close both the remote stream and buffer stream + */ + public function close(): void + { + $this->remoteStream->close(); + $this->stream->close(); + } + + private function cacheEntireStream(): int + { + $target = new FnStream(['write' => 'strlen']); + Utils::copyToStream($this, $target); + + return $this->tell(); + } +} diff --git a/lib/guzzlehttp/psr7/src/DroppingStream.php b/lib/guzzlehttp/psr7/src/DroppingStream.php new file mode 100644 index 00000000..d78070ae --- /dev/null +++ b/lib/guzzlehttp/psr7/src/DroppingStream.php @@ -0,0 +1,46 @@ +stream = $stream; + $this->maxLength = $maxLength; + } + + public function write($string): int + { + $diff = $this->maxLength - $this->stream->getSize(); + + // Begin returning 0 when the underlying stream is too large. + if ($diff <= 0) { + return 0; + } + + // Write the stream or a subset of the stream if needed. + if (strlen($string) < $diff) { + return $this->stream->write($string); + } + + return $this->stream->write(substr($string, 0, $diff)); + } +} diff --git a/lib/guzzlehttp/psr7/src/Exception/MalformedUriException.php b/lib/guzzlehttp/psr7/src/Exception/MalformedUriException.php new file mode 100644 index 00000000..3a084779 --- /dev/null +++ b/lib/guzzlehttp/psr7/src/Exception/MalformedUriException.php @@ -0,0 +1,14 @@ + */ + private $methods; + + /** + * @param array $methods Hash of method name to a callable. + */ + public function __construct(array $methods) + { + $this->methods = $methods; + + // Create the functions on the class + foreach ($methods as $name => $fn) { + $this->{'_fn_' . $name} = $fn; + } + } + + /** + * Lazily determine which methods are not implemented. + * + * @throws \BadMethodCallException + */ + public function __get(string $name): void + { + throw new \BadMethodCallException(str_replace('_fn_', '', $name) + . '() is not implemented in the FnStream'); + } + + /** + * The close method is called on the underlying stream only if possible. + */ + public function __destruct() + { + if (isset($this->_fn_close)) { + call_user_func($this->_fn_close); + } + } + + /** + * An unserialize would allow the __destruct to run when the unserialized value goes out of scope. + * + * @throws \LogicException + */ + public function __wakeup(): void + { + throw new \LogicException('FnStream should never be unserialized'); + } + + /** + * Adds custom functionality to an underlying stream by intercepting + * specific method calls. + * + * @param StreamInterface $stream Stream to decorate + * @param array $methods Hash of method name to a closure + * + * @return FnStream + */ + public static function decorate(StreamInterface $stream, array $methods) + { + // If any of the required methods were not provided, then simply + // proxy to the decorated stream. + foreach (array_diff(self::SLOTS, array_keys($methods)) as $diff) { + /** @var callable $callable */ + $callable = [$stream, $diff]; + $methods[$diff] = $callable; + } + + return new self($methods); + } + + public function __toString(): string + { + try { + return call_user_func($this->_fn___toString); + } catch (\Throwable $e) { + if (\PHP_VERSION_ID >= 70400) { + throw $e; + } + trigger_error(sprintf('%s::__toString exception: %s', self::class, (string) $e), E_USER_ERROR); + return ''; + } + } + + public function close(): void + { + call_user_func($this->_fn_close); + } + + public function detach() + { + return call_user_func($this->_fn_detach); + } + + public function getSize(): ?int + { + return call_user_func($this->_fn_getSize); + } + + public function tell(): int + { + return call_user_func($this->_fn_tell); + } + + public function eof(): bool + { + return call_user_func($this->_fn_eof); + } + + public function isSeekable(): bool + { + return call_user_func($this->_fn_isSeekable); + } + + public function rewind(): void + { + call_user_func($this->_fn_rewind); + } + + public function seek($offset, $whence = SEEK_SET): void + { + call_user_func($this->_fn_seek, $offset, $whence); + } + + public function isWritable(): bool + { + return call_user_func($this->_fn_isWritable); + } + + public function write($string): int + { + return call_user_func($this->_fn_write, $string); + } + + public function isReadable(): bool + { + return call_user_func($this->_fn_isReadable); + } + + public function read($length): string + { + return call_user_func($this->_fn_read, $length); + } + + public function getContents(): string + { + return call_user_func($this->_fn_getContents); + } + + /** + * {@inheritdoc} + * + * @return mixed + */ + public function getMetadata($key = null) + { + return call_user_func($this->_fn_getMetadata, $key); + } +} diff --git a/lib/guzzlehttp/psr7/src/Header.php b/lib/guzzlehttp/psr7/src/Header.php new file mode 100644 index 00000000..0e79a71a --- /dev/null +++ b/lib/guzzlehttp/psr7/src/Header.php @@ -0,0 +1,69 @@ +]+>|[^=]+/', $kvp, $matches)) { + $m = $matches[0]; + if (isset($m[1])) { + $part[trim($m[0], $trimmed)] = trim($m[1], $trimmed); + } else { + $part[] = trim($m[0], $trimmed); + } + } + } + if ($part) { + $params[] = $part; + } + } + + return $params; + } + + /** + * Converts an array of header values that may contain comma separated + * headers into an array of headers with no comma separated values. + * + * @param string|array $header Header to normalize. + */ + public static function normalize($header): array + { + if (!is_array($header)) { + return array_map('trim', explode(',', $header)); + } + + $result = []; + foreach ($header as $value) { + foreach ((array) $value as $v) { + if (strpos($v, ',') === false) { + $result[] = $v; + continue; + } + foreach (preg_split('/,(?=([^"]*"[^"]*")*[^"]*$)/', $v) as $vv) { + $result[] = trim($vv); + } + } + } + + return $result; + } +} diff --git a/lib/guzzlehttp/psr7/src/HttpFactory.php b/lib/guzzlehttp/psr7/src/HttpFactory.php new file mode 100644 index 00000000..30be222f --- /dev/null +++ b/lib/guzzlehttp/psr7/src/HttpFactory.php @@ -0,0 +1,100 @@ +getSize(); + } + + return new UploadedFile($stream, $size, $error, $clientFilename, $clientMediaType); + } + + public function createStream(string $content = ''): StreamInterface + { + return Utils::streamFor($content); + } + + public function createStreamFromFile(string $file, string $mode = 'r'): StreamInterface + { + try { + $resource = Utils::tryFopen($file, $mode); + } catch (\RuntimeException $e) { + if ('' === $mode || false === \in_array($mode[0], ['r', 'w', 'a', 'x', 'c'], true)) { + throw new \InvalidArgumentException(sprintf('Invalid file opening mode "%s"', $mode), 0, $e); + } + + throw $e; + } + + return Utils::streamFor($resource); + } + + public function createStreamFromResource($resource): StreamInterface + { + return Utils::streamFor($resource); + } + + public function createServerRequest(string $method, $uri, array $serverParams = []): ServerRequestInterface + { + if (empty($method)) { + if (!empty($serverParams['REQUEST_METHOD'])) { + $method = $serverParams['REQUEST_METHOD']; + } else { + throw new \InvalidArgumentException('Cannot determine HTTP method'); + } + } + + return new ServerRequest($method, $uri, [], null, '1.1', $serverParams); + } + + public function createResponse(int $code = 200, string $reasonPhrase = ''): ResponseInterface + { + return new Response($code, [], null, '1.1', $reasonPhrase); + } + + public function createRequest(string $method, $uri): RequestInterface + { + return new Request($method, $uri); + } + + public function createUri(string $uri = ''): UriInterface + { + return new Uri($uri); + } +} diff --git a/lib/guzzlehttp/psr7/src/InflateStream.php b/lib/guzzlehttp/psr7/src/InflateStream.php new file mode 100644 index 00000000..8e3cf171 --- /dev/null +++ b/lib/guzzlehttp/psr7/src/InflateStream.php @@ -0,0 +1,34 @@ + 15 + 32]); + $this->stream = $stream->isSeekable() ? new Stream($resource) : new NoSeekStream(new Stream($resource)); + } +} diff --git a/lib/guzzlehttp/psr7/src/LazyOpenStream.php b/lib/guzzlehttp/psr7/src/LazyOpenStream.php new file mode 100644 index 00000000..6b604296 --- /dev/null +++ b/lib/guzzlehttp/psr7/src/LazyOpenStream.php @@ -0,0 +1,40 @@ +filename = $filename; + $this->mode = $mode; + } + + /** + * Creates the underlying stream lazily when required. + */ + protected function createStream(): StreamInterface + { + return Utils::streamFor(Utils::tryFopen($this->filename, $this->mode)); + } +} diff --git a/lib/guzzlehttp/psr7/src/LimitStream.php b/lib/guzzlehttp/psr7/src/LimitStream.php new file mode 100644 index 00000000..9762d38a --- /dev/null +++ b/lib/guzzlehttp/psr7/src/LimitStream.php @@ -0,0 +1,154 @@ +stream = $stream; + $this->setLimit($limit); + $this->setOffset($offset); + } + + public function eof(): bool + { + // Always return true if the underlying stream is EOF + if ($this->stream->eof()) { + return true; + } + + // No limit and the underlying stream is not at EOF + if ($this->limit === -1) { + return false; + } + + return $this->stream->tell() >= $this->offset + $this->limit; + } + + /** + * Returns the size of the limited subset of data + */ + public function getSize(): ?int + { + if (null === ($length = $this->stream->getSize())) { + return null; + } elseif ($this->limit === -1) { + return $length - $this->offset; + } else { + return min($this->limit, $length - $this->offset); + } + } + + /** + * Allow for a bounded seek on the read limited stream + */ + public function seek($offset, $whence = SEEK_SET): void + { + if ($whence !== SEEK_SET || $offset < 0) { + throw new \RuntimeException(sprintf( + 'Cannot seek to offset %s with whence %s', + $offset, + $whence + )); + } + + $offset += $this->offset; + + if ($this->limit !== -1) { + if ($offset > $this->offset + $this->limit) { + $offset = $this->offset + $this->limit; + } + } + + $this->stream->seek($offset); + } + + /** + * Give a relative tell() + */ + public function tell(): int + { + return $this->stream->tell() - $this->offset; + } + + /** + * Set the offset to start limiting from + * + * @param int $offset Offset to seek to and begin byte limiting from + * + * @throws \RuntimeException if the stream cannot be seeked. + */ + public function setOffset(int $offset): void + { + $current = $this->stream->tell(); + + if ($current !== $offset) { + // If the stream cannot seek to the offset position, then read to it + if ($this->stream->isSeekable()) { + $this->stream->seek($offset); + } elseif ($current > $offset) { + throw new \RuntimeException("Could not seek to stream offset $offset"); + } else { + $this->stream->read($offset - $current); + } + } + + $this->offset = $offset; + } + + /** + * Set the limit of bytes that the decorator allows to be read from the + * stream. + * + * @param int $limit Number of bytes to allow to be read from the stream. + * Use -1 for no limit. + */ + public function setLimit(int $limit): void + { + $this->limit = $limit; + } + + public function read($length): string + { + if ($this->limit === -1) { + return $this->stream->read($length); + } + + // Check if the current position is less than the total allowed + // bytes + original offset + $remaining = ($this->offset + $this->limit) - $this->stream->tell(); + if ($remaining > 0) { + // Only return the amount of requested data, ensuring that the byte + // limit is not exceeded + return $this->stream->read(min($remaining, $length)); + } + + return ''; + } +} diff --git a/lib/guzzlehttp/psr7/src/Message.php b/lib/guzzlehttp/psr7/src/Message.php new file mode 100644 index 00000000..9b825b30 --- /dev/null +++ b/lib/guzzlehttp/psr7/src/Message.php @@ -0,0 +1,242 @@ +getMethod() . ' ' + . $message->getRequestTarget()) + . ' HTTP/' . $message->getProtocolVersion(); + if (!$message->hasHeader('host')) { + $msg .= "\r\nHost: " . $message->getUri()->getHost(); + } + } elseif ($message instanceof ResponseInterface) { + $msg = 'HTTP/' . $message->getProtocolVersion() . ' ' + . $message->getStatusCode() . ' ' + . $message->getReasonPhrase(); + } else { + throw new \InvalidArgumentException('Unknown message type'); + } + + foreach ($message->getHeaders() as $name => $values) { + if (strtolower($name) === 'set-cookie') { + foreach ($values as $value) { + $msg .= "\r\n{$name}: " . $value; + } + } else { + $msg .= "\r\n{$name}: " . implode(', ', $values); + } + } + + return "{$msg}\r\n\r\n" . $message->getBody(); + } + + /** + * Get a short summary of the message body. + * + * Will return `null` if the response is not printable. + * + * @param MessageInterface $message The message to get the body summary + * @param int $truncateAt The maximum allowed size of the summary + */ + public static function bodySummary(MessageInterface $message, int $truncateAt = 120): ?string + { + $body = $message->getBody(); + + if (!$body->isSeekable() || !$body->isReadable()) { + return null; + } + + $size = $body->getSize(); + + if ($size === 0) { + return null; + } + + $summary = $body->read($truncateAt); + $body->rewind(); + + if ($size > $truncateAt) { + $summary .= ' (truncated...)'; + } + + // Matches any printable character, including unicode characters: + // letters, marks, numbers, punctuation, spacing, and separators. + if (preg_match('/[^\pL\pM\pN\pP\pS\pZ\n\r\t]/u', $summary)) { + return null; + } + + return $summary; + } + + /** + * Attempts to rewind a message body and throws an exception on failure. + * + * The body of the message will only be rewound if a call to `tell()` + * returns a value other than `0`. + * + * @param MessageInterface $message Message to rewind + * + * @throws \RuntimeException + */ + public static function rewindBody(MessageInterface $message): void + { + $body = $message->getBody(); + + if ($body->tell()) { + $body->rewind(); + } + } + + /** + * Parses an HTTP message into an associative array. + * + * The array contains the "start-line" key containing the start line of + * the message, "headers" key containing an associative array of header + * array values, and a "body" key containing the body of the message. + * + * @param string $message HTTP request or response to parse. + */ + public static function parseMessage(string $message): array + { + if (!$message) { + throw new \InvalidArgumentException('Invalid message'); + } + + $message = ltrim($message, "\r\n"); + + $messageParts = preg_split("/\r?\n\r?\n/", $message, 2); + + if ($messageParts === false || count($messageParts) !== 2) { + throw new \InvalidArgumentException('Invalid message: Missing header delimiter'); + } + + [$rawHeaders, $body] = $messageParts; + $rawHeaders .= "\r\n"; // Put back the delimiter we split previously + $headerParts = preg_split("/\r?\n/", $rawHeaders, 2); + + if ($headerParts === false || count($headerParts) !== 2) { + throw new \InvalidArgumentException('Invalid message: Missing status line'); + } + + [$startLine, $rawHeaders] = $headerParts; + + if (preg_match("/(?:^HTTP\/|^[A-Z]+ \S+ HTTP\/)(\d+(?:\.\d+)?)/i", $startLine, $matches) && $matches[1] === '1.0') { + // Header folding is deprecated for HTTP/1.1, but allowed in HTTP/1.0 + $rawHeaders = preg_replace(Rfc7230::HEADER_FOLD_REGEX, ' ', $rawHeaders); + } + + /** @var array[] $headerLines */ + $count = preg_match_all(Rfc7230::HEADER_REGEX, $rawHeaders, $headerLines, PREG_SET_ORDER); + + // If these aren't the same, then one line didn't match and there's an invalid header. + if ($count !== substr_count($rawHeaders, "\n")) { + // Folding is deprecated, see https://tools.ietf.org/html/rfc7230#section-3.2.4 + if (preg_match(Rfc7230::HEADER_FOLD_REGEX, $rawHeaders)) { + throw new \InvalidArgumentException('Invalid header syntax: Obsolete line folding'); + } + + throw new \InvalidArgumentException('Invalid header syntax'); + } + + $headers = []; + + foreach ($headerLines as $headerLine) { + $headers[$headerLine[1]][] = $headerLine[2]; + } + + return [ + 'start-line' => $startLine, + 'headers' => $headers, + 'body' => $body, + ]; + } + + /** + * Constructs a URI for an HTTP request message. + * + * @param string $path Path from the start-line + * @param array $headers Array of headers (each value an array). + */ + public static function parseRequestUri(string $path, array $headers): string + { + $hostKey = array_filter(array_keys($headers), function ($k) { + return strtolower($k) === 'host'; + }); + + // If no host is found, then a full URI cannot be constructed. + if (!$hostKey) { + return $path; + } + + $host = $headers[reset($hostKey)][0]; + $scheme = substr($host, -4) === ':443' ? 'https' : 'http'; + + return $scheme . '://' . $host . '/' . ltrim($path, '/'); + } + + /** + * Parses a request message string into a request object. + * + * @param string $message Request message string. + */ + public static function parseRequest(string $message): RequestInterface + { + $data = self::parseMessage($message); + $matches = []; + if (!preg_match('/^[\S]+\s+([a-zA-Z]+:\/\/|\/).*/', $data['start-line'], $matches)) { + throw new \InvalidArgumentException('Invalid request string'); + } + $parts = explode(' ', $data['start-line'], 3); + $version = isset($parts[2]) ? explode('/', $parts[2])[1] : '1.1'; + + $request = new Request( + $parts[0], + $matches[1] === '/' ? self::parseRequestUri($parts[1], $data['headers']) : $parts[1], + $data['headers'], + $data['body'], + $version + ); + + return $matches[1] === '/' ? $request : $request->withRequestTarget($parts[1]); + } + + /** + * Parses a response message string into a response object. + * + * @param string $message Response message string. + */ + public static function parseResponse(string $message): ResponseInterface + { + $data = self::parseMessage($message); + // According to https://tools.ietf.org/html/rfc7230#section-3.1.2 the space + // between status-code and reason-phrase is required. But browsers accept + // responses without space and reason as well. + if (!preg_match('/^HTTP\/.* [0-9]{3}( .*|$)/', $data['start-line'])) { + throw new \InvalidArgumentException('Invalid response string: ' . $data['start-line']); + } + $parts = explode(' ', $data['start-line'], 3); + + return new Response( + (int) $parts[1], + $data['headers'], + $data['body'], + explode('/', $parts[0])[1], + $parts[2] ?? null + ); + } +} diff --git a/lib/guzzlehttp/psr7/src/MessageTrait.php b/lib/guzzlehttp/psr7/src/MessageTrait.php new file mode 100644 index 00000000..503c280b --- /dev/null +++ b/lib/guzzlehttp/psr7/src/MessageTrait.php @@ -0,0 +1,235 @@ + Map of all registered headers, as original name => array of values */ + private $headers = []; + + /** @var array Map of lowercase header name => original name at registration */ + private $headerNames = []; + + /** @var string */ + private $protocol = '1.1'; + + /** @var StreamInterface|null */ + private $stream; + + public function getProtocolVersion(): string + { + return $this->protocol; + } + + public function withProtocolVersion($version): MessageInterface + { + if ($this->protocol === $version) { + return $this; + } + + $new = clone $this; + $new->protocol = $version; + return $new; + } + + public function getHeaders(): array + { + return $this->headers; + } + + public function hasHeader($header): bool + { + return isset($this->headerNames[strtolower($header)]); + } + + public function getHeader($header): array + { + $header = strtolower($header); + + if (!isset($this->headerNames[$header])) { + return []; + } + + $header = $this->headerNames[$header]; + + return $this->headers[$header]; + } + + public function getHeaderLine($header): string + { + return implode(', ', $this->getHeader($header)); + } + + public function withHeader($header, $value): MessageInterface + { + $this->assertHeader($header); + $value = $this->normalizeHeaderValue($value); + $normalized = strtolower($header); + + $new = clone $this; + if (isset($new->headerNames[$normalized])) { + unset($new->headers[$new->headerNames[$normalized]]); + } + $new->headerNames[$normalized] = $header; + $new->headers[$header] = $value; + + return $new; + } + + public function withAddedHeader($header, $value): MessageInterface + { + $this->assertHeader($header); + $value = $this->normalizeHeaderValue($value); + $normalized = strtolower($header); + + $new = clone $this; + if (isset($new->headerNames[$normalized])) { + $header = $this->headerNames[$normalized]; + $new->headers[$header] = array_merge($this->headers[$header], $value); + } else { + $new->headerNames[$normalized] = $header; + $new->headers[$header] = $value; + } + + return $new; + } + + public function withoutHeader($header): MessageInterface + { + $normalized = strtolower($header); + + if (!isset($this->headerNames[$normalized])) { + return $this; + } + + $header = $this->headerNames[$normalized]; + + $new = clone $this; + unset($new->headers[$header], $new->headerNames[$normalized]); + + return $new; + } + + public function getBody(): StreamInterface + { + if (!$this->stream) { + $this->stream = Utils::streamFor(''); + } + + return $this->stream; + } + + public function withBody(StreamInterface $body): MessageInterface + { + if ($body === $this->stream) { + return $this; + } + + $new = clone $this; + $new->stream = $body; + return $new; + } + + /** + * @param array $headers + */ + private function setHeaders(array $headers): void + { + $this->headerNames = $this->headers = []; + foreach ($headers as $header => $value) { + if (is_int($header)) { + // Numeric array keys are converted to int by PHP but having a header name '123' is not forbidden by the spec + // and also allowed in withHeader(). So we need to cast it to string again for the following assertion to pass. + $header = (string) $header; + } + $this->assertHeader($header); + $value = $this->normalizeHeaderValue($value); + $normalized = strtolower($header); + if (isset($this->headerNames[$normalized])) { + $header = $this->headerNames[$normalized]; + $this->headers[$header] = array_merge($this->headers[$header], $value); + } else { + $this->headerNames[$normalized] = $header; + $this->headers[$header] = $value; + } + } + } + + /** + * @param mixed $value + * + * @return string[] + */ + private function normalizeHeaderValue($value): array + { + if (!is_array($value)) { + return $this->trimHeaderValues([$value]); + } + + if (count($value) === 0) { + throw new \InvalidArgumentException('Header value can not be an empty array.'); + } + + return $this->trimHeaderValues($value); + } + + /** + * Trims whitespace from the header values. + * + * Spaces and tabs ought to be excluded by parsers when extracting the field value from a header field. + * + * header-field = field-name ":" OWS field-value OWS + * OWS = *( SP / HTAB ) + * + * @param mixed[] $values Header values + * + * @return string[] Trimmed header values + * + * @see https://tools.ietf.org/html/rfc7230#section-3.2.4 + */ + private function trimHeaderValues(array $values): array + { + return array_map(function ($value) { + if (!is_scalar($value) && null !== $value) { + throw new \InvalidArgumentException(sprintf( + 'Header value must be scalar or null but %s provided.', + is_object($value) ? get_class($value) : gettype($value) + )); + } + + return trim((string) $value, " \t"); + }, array_values($values)); + } + + /** + * @see https://tools.ietf.org/html/rfc7230#section-3.2 + * + * @param mixed $header + */ + private function assertHeader($header): void + { + if (!is_string($header)) { + throw new \InvalidArgumentException(sprintf( + 'Header name must be a string but %s provided.', + is_object($header) ? get_class($header) : gettype($header) + )); + } + + if (! preg_match('/^[a-zA-Z0-9\'`#$%&*+.^_|~!-]+$/', $header)) { + throw new \InvalidArgumentException( + sprintf( + '"%s" is not valid header name', + $header + ) + ); + } + } +} diff --git a/lib/guzzlehttp/psr7/src/MimeType.php b/lib/guzzlehttp/psr7/src/MimeType.php new file mode 100644 index 00000000..dfa94251 --- /dev/null +++ b/lib/guzzlehttp/psr7/src/MimeType.php @@ -0,0 +1,130 @@ + 'video/3gpp', + '7z' => 'application/x-7z-compressed', + 'aac' => 'audio/x-aac', + 'ai' => 'application/postscript', + 'aif' => 'audio/x-aiff', + 'asc' => 'text/plain', + 'asf' => 'video/x-ms-asf', + 'atom' => 'application/atom+xml', + 'avi' => 'video/x-msvideo', + 'bmp' => 'image/bmp', + 'bz2' => 'application/x-bzip2', + 'cer' => 'application/pkix-cert', + 'crl' => 'application/pkix-crl', + 'crt' => 'application/x-x509-ca-cert', + 'css' => 'text/css', + 'csv' => 'text/csv', + 'cu' => 'application/cu-seeme', + 'deb' => 'application/x-debian-package', + 'doc' => 'application/msword', + 'docx' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.document', + 'dvi' => 'application/x-dvi', + 'eot' => 'application/vnd.ms-fontobject', + 'eps' => 'application/postscript', + 'epub' => 'application/epub+zip', + 'etx' => 'text/x-setext', + 'flac' => 'audio/flac', + 'flv' => 'video/x-flv', + 'gif' => 'image/gif', + 'gz' => 'application/gzip', + 'htm' => 'text/html', + 'html' => 'text/html', + 'ico' => 'image/x-icon', + 'ics' => 'text/calendar', + 'ini' => 'text/plain', + 'iso' => 'application/x-iso9660-image', + 'jar' => 'application/java-archive', + 'jpe' => 'image/jpeg', + 'jpeg' => 'image/jpeg', + 'jpg' => 'image/jpeg', + 'js' => 'text/javascript', + 'json' => 'application/json', + 'latex' => 'application/x-latex', + 'log' => 'text/plain', + 'm4a' => 'audio/mp4', + 'm4v' => 'video/mp4', + 'mid' => 'audio/midi', + 'midi' => 'audio/midi', + 'mov' => 'video/quicktime', + 'mkv' => 'video/x-matroska', + 'mp3' => 'audio/mpeg', + 'mp4' => 'video/mp4', + 'mp4a' => 'audio/mp4', + 'mp4v' => 'video/mp4', + 'mpe' => 'video/mpeg', + 'mpeg' => 'video/mpeg', + 'mpg' => 'video/mpeg', + 'mpg4' => 'video/mp4', + 'oga' => 'audio/ogg', + 'ogg' => 'audio/ogg', + 'ogv' => 'video/ogg', + 'ogx' => 'application/ogg', + 'pbm' => 'image/x-portable-bitmap', + 'pdf' => 'application/pdf', + 'pgm' => 'image/x-portable-graymap', + 'png' => 'image/png', + 'pnm' => 'image/x-portable-anymap', + 'ppm' => 'image/x-portable-pixmap', + 'ppt' => 'application/vnd.ms-powerpoint', + 'pptx' => 'application/vnd.openxmlformats-officedocument.presentationml.presentation', + 'ps' => 'application/postscript', + 'qt' => 'video/quicktime', + 'rar' => 'application/x-rar-compressed', + 'ras' => 'image/x-cmu-raster', + 'rss' => 'application/rss+xml', + 'rtf' => 'application/rtf', + 'sgm' => 'text/sgml', + 'sgml' => 'text/sgml', + 'svg' => 'image/svg+xml', + 'swf' => 'application/x-shockwave-flash', + 'tar' => 'application/x-tar', + 'tif' => 'image/tiff', + 'tiff' => 'image/tiff', + 'torrent' => 'application/x-bittorrent', + 'ttf' => 'application/x-font-ttf', + 'txt' => 'text/plain', + 'wav' => 'audio/x-wav', + 'webm' => 'video/webm', + 'webp' => 'image/webp', + 'wma' => 'audio/x-ms-wma', + 'wmv' => 'video/x-ms-wmv', + 'woff' => 'application/x-font-woff', + 'wsdl' => 'application/wsdl+xml', + 'xbm' => 'image/x-xbitmap', + 'xls' => 'application/vnd.ms-excel', + 'xlsx' => 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', + 'xml' => 'application/xml', + 'xpm' => 'image/x-xpixmap', + 'xwd' => 'image/x-xwindowdump', + 'yaml' => 'text/yaml', + 'yml' => 'text/yaml', + 'zip' => 'application/zip', + ]; + + /** + * Determines the mimetype of a file by looking at its extension. + */ + public static function fromFilename(string $filename): ?string + { + return self::fromExtension(pathinfo($filename, PATHINFO_EXTENSION)); + } + + /** + * Maps a file extensions to a mimetype. + * + * @link http://svn.apache.org/repos/asf/httpd/httpd/branches/1.3.x/conf/mime.types + */ + public static function fromExtension(string $extension): ?string + { + return self::MIME_TYPES[strtolower($extension)] ?? null; + } +} diff --git a/lib/guzzlehttp/psr7/src/MultipartStream.php b/lib/guzzlehttp/psr7/src/MultipartStream.php new file mode 100644 index 00000000..f76d7c61 --- /dev/null +++ b/lib/guzzlehttp/psr7/src/MultipartStream.php @@ -0,0 +1,153 @@ +boundary = $boundary ?: sha1(uniqid('', true)); + $this->stream = $this->createStream($elements); + } + + public function getBoundary(): string + { + return $this->boundary; + } + + public function isWritable(): bool + { + return false; + } + + /** + * Get the headers needed before transferring the content of a POST file + * + * @param array $headers + */ + private function getHeaders(array $headers): string + { + $str = ''; + foreach ($headers as $key => $value) { + $str .= "{$key}: {$value}\r\n"; + } + + return "--{$this->boundary}\r\n" . trim($str) . "\r\n\r\n"; + } + + /** + * Create the aggregate stream that will be used to upload the POST data + */ + protected function createStream(array $elements = []): StreamInterface + { + $stream = new AppendStream(); + + foreach ($elements as $element) { + $this->addElement($stream, $element); + } + + // Add the trailing boundary with CRLF + $stream->addStream(Utils::streamFor("--{$this->boundary}--\r\n")); + + return $stream; + } + + private function addElement(AppendStream $stream, array $element): void + { + foreach (['contents', 'name'] as $key) { + if (!array_key_exists($key, $element)) { + throw new \InvalidArgumentException("A '{$key}' key is required"); + } + } + + $element['contents'] = Utils::streamFor($element['contents']); + + if (empty($element['filename'])) { + $uri = $element['contents']->getMetadata('uri'); + if (substr($uri, 0, 6) !== 'php://') { + $element['filename'] = $uri; + } + } + + [$body, $headers] = $this->createElement( + $element['name'], + $element['contents'], + $element['filename'] ?? null, + $element['headers'] ?? [] + ); + + $stream->addStream(Utils::streamFor($this->getHeaders($headers))); + $stream->addStream($body); + $stream->addStream(Utils::streamFor("\r\n")); + } + + private function createElement(string $name, StreamInterface $stream, ?string $filename, array $headers): array + { + // Set a default content-disposition header if one was no provided + $disposition = $this->getHeader($headers, 'content-disposition'); + if (!$disposition) { + $headers['Content-Disposition'] = ($filename === '0' || $filename) + ? sprintf( + 'form-data; name="%s"; filename="%s"', + $name, + basename($filename) + ) + : "form-data; name=\"{$name}\""; + } + + // Set a default content-length header if one was no provided + $length = $this->getHeader($headers, 'content-length'); + if (!$length) { + if ($length = $stream->getSize()) { + $headers['Content-Length'] = (string) $length; + } + } + + // Set a default Content-Type if one was not supplied + $type = $this->getHeader($headers, 'content-type'); + if (!$type && ($filename === '0' || $filename)) { + if ($type = MimeType::fromFilename($filename)) { + $headers['Content-Type'] = $type; + } + } + + return [$stream, $headers]; + } + + private function getHeader(array $headers, string $key) + { + $lowercaseHeader = strtolower($key); + foreach ($headers as $k => $v) { + if (strtolower($k) === $lowercaseHeader) { + return $v; + } + } + + return null; + } +} diff --git a/lib/guzzlehttp/psr7/src/NoSeekStream.php b/lib/guzzlehttp/psr7/src/NoSeekStream.php new file mode 100644 index 00000000..99e25b9e --- /dev/null +++ b/lib/guzzlehttp/psr7/src/NoSeekStream.php @@ -0,0 +1,25 @@ +source = $source; + $this->size = $options['size'] ?? null; + $this->metadata = $options['metadata'] ?? []; + $this->buffer = new BufferStream(); + } + + public function __toString(): string + { + try { + return Utils::copyToString($this); + } catch (\Throwable $e) { + if (\PHP_VERSION_ID >= 70400) { + throw $e; + } + trigger_error(sprintf('%s::__toString exception: %s', self::class, (string) $e), E_USER_ERROR); + return ''; + } + } + + public function close(): void + { + $this->detach(); + } + + public function detach() + { + $this->tellPos = 0; + $this->source = null; + + return null; + } + + public function getSize(): ?int + { + return $this->size; + } + + public function tell(): int + { + return $this->tellPos; + } + + public function eof(): bool + { + return $this->source === null; + } + + public function isSeekable(): bool + { + return false; + } + + public function rewind(): void + { + $this->seek(0); + } + + public function seek($offset, $whence = SEEK_SET): void + { + throw new \RuntimeException('Cannot seek a PumpStream'); + } + + public function isWritable(): bool + { + return false; + } + + public function write($string): int + { + throw new \RuntimeException('Cannot write to a PumpStream'); + } + + public function isReadable(): bool + { + return true; + } + + public function read($length): string + { + $data = $this->buffer->read($length); + $readLen = strlen($data); + $this->tellPos += $readLen; + $remaining = $length - $readLen; + + if ($remaining) { + $this->pump($remaining); + $data .= $this->buffer->read($remaining); + $this->tellPos += strlen($data) - $readLen; + } + + return $data; + } + + public function getContents(): string + { + $result = ''; + while (!$this->eof()) { + $result .= $this->read(1000000); + } + + return $result; + } + + /** + * {@inheritdoc} + * + * @return mixed + */ + public function getMetadata($key = null) + { + if (!$key) { + return $this->metadata; + } + + return $this->metadata[$key] ?? null; + } + + private function pump(int $length): void + { + if ($this->source) { + do { + $data = call_user_func($this->source, $length); + if ($data === false || $data === null) { + $this->source = null; + return; + } + $this->buffer->write($data); + $length -= strlen($data); + } while ($length > 0); + } + } +} diff --git a/lib/guzzlehttp/psr7/src/Query.php b/lib/guzzlehttp/psr7/src/Query.php new file mode 100644 index 00000000..4fd0ca96 --- /dev/null +++ b/lib/guzzlehttp/psr7/src/Query.php @@ -0,0 +1,113 @@ + '1', 'foo[b]' => '2'])`. + * + * @param string $str Query string to parse + * @param int|bool $urlEncoding How the query string is encoded + */ + public static function parse(string $str, $urlEncoding = true): array + { + $result = []; + + if ($str === '') { + return $result; + } + + if ($urlEncoding === true) { + $decoder = function ($value) { + return rawurldecode(str_replace('+', ' ', (string) $value)); + }; + } elseif ($urlEncoding === PHP_QUERY_RFC3986) { + $decoder = 'rawurldecode'; + } elseif ($urlEncoding === PHP_QUERY_RFC1738) { + $decoder = 'urldecode'; + } else { + $decoder = function ($str) { + return $str; + }; + } + + foreach (explode('&', $str) as $kvp) { + $parts = explode('=', $kvp, 2); + $key = $decoder($parts[0]); + $value = isset($parts[1]) ? $decoder($parts[1]) : null; + if (!isset($result[$key])) { + $result[$key] = $value; + } else { + if (!is_array($result[$key])) { + $result[$key] = [$result[$key]]; + } + $result[$key][] = $value; + } + } + + return $result; + } + + /** + * Build a query string from an array of key value pairs. + * + * This function can use the return value of `parse()` to build a query + * string. This function does not modify the provided keys when an array is + * encountered (like `http_build_query()` would). + * + * @param array $params Query string parameters. + * @param int|false $encoding Set to false to not encode, PHP_QUERY_RFC3986 + * to encode using RFC3986, or PHP_QUERY_RFC1738 + * to encode using RFC1738. + */ + public static function build(array $params, $encoding = PHP_QUERY_RFC3986): string + { + if (!$params) { + return ''; + } + + if ($encoding === false) { + $encoder = function (string $str): string { + return $str; + }; + } elseif ($encoding === PHP_QUERY_RFC3986) { + $encoder = 'rawurlencode'; + } elseif ($encoding === PHP_QUERY_RFC1738) { + $encoder = 'urlencode'; + } else { + throw new \InvalidArgumentException('Invalid type'); + } + + $qs = ''; + foreach ($params as $k => $v) { + $k = $encoder((string) $k); + if (!is_array($v)) { + $qs .= $k; + $v = is_bool($v) ? (int) $v : $v; + if ($v !== null) { + $qs .= '=' . $encoder((string) $v); + } + $qs .= '&'; + } else { + foreach ($v as $vv) { + $qs .= $k; + $vv = is_bool($vv) ? (int) $vv : $vv; + if ($vv !== null) { + $qs .= '=' . $encoder((string) $vv); + } + $qs .= '&'; + } + } + } + + return $qs ? (string) substr($qs, 0, -1) : ''; + } +} diff --git a/lib/guzzlehttp/psr7/src/Request.php b/lib/guzzlehttp/psr7/src/Request.php new file mode 100644 index 00000000..b17af66a --- /dev/null +++ b/lib/guzzlehttp/psr7/src/Request.php @@ -0,0 +1,157 @@ + $headers Request headers + * @param string|resource|StreamInterface|null $body Request body + * @param string $version Protocol version + */ + public function __construct( + string $method, + $uri, + array $headers = [], + $body = null, + string $version = '1.1' + ) { + $this->assertMethod($method); + if (!($uri instanceof UriInterface)) { + $uri = new Uri($uri); + } + + $this->method = strtoupper($method); + $this->uri = $uri; + $this->setHeaders($headers); + $this->protocol = $version; + + if (!isset($this->headerNames['host'])) { + $this->updateHostFromUri(); + } + + if ($body !== '' && $body !== null) { + $this->stream = Utils::streamFor($body); + } + } + + public function getRequestTarget(): string + { + if ($this->requestTarget !== null) { + return $this->requestTarget; + } + + $target = $this->uri->getPath(); + if ($target === '') { + $target = '/'; + } + if ($this->uri->getQuery() != '') { + $target .= '?' . $this->uri->getQuery(); + } + + return $target; + } + + public function withRequestTarget($requestTarget): RequestInterface + { + if (preg_match('#\s#', $requestTarget)) { + throw new InvalidArgumentException( + 'Invalid request target provided; cannot contain whitespace' + ); + } + + $new = clone $this; + $new->requestTarget = $requestTarget; + return $new; + } + + public function getMethod(): string + { + return $this->method; + } + + public function withMethod($method): RequestInterface + { + $this->assertMethod($method); + $new = clone $this; + $new->method = strtoupper($method); + return $new; + } + + public function getUri(): UriInterface + { + return $this->uri; + } + + public function withUri(UriInterface $uri, $preserveHost = false): RequestInterface + { + if ($uri === $this->uri) { + return $this; + } + + $new = clone $this; + $new->uri = $uri; + + if (!$preserveHost || !isset($this->headerNames['host'])) { + $new->updateHostFromUri(); + } + + return $new; + } + + private function updateHostFromUri(): void + { + $host = $this->uri->getHost(); + + if ($host == '') { + return; + } + + if (($port = $this->uri->getPort()) !== null) { + $host .= ':' . $port; + } + + if (isset($this->headerNames['host'])) { + $header = $this->headerNames['host']; + } else { + $header = 'Host'; + $this->headerNames['host'] = 'Host'; + } + // Ensure Host is the first header. + // See: http://tools.ietf.org/html/rfc7230#section-5.4 + $this->headers = [$header => [$host]] + $this->headers; + } + + /** + * @param mixed $method + */ + private function assertMethod($method): void + { + if (!is_string($method) || $method === '') { + throw new InvalidArgumentException('Method must be a non-empty string.'); + } + } +} diff --git a/lib/guzzlehttp/psr7/src/Response.php b/lib/guzzlehttp/psr7/src/Response.php new file mode 100644 index 00000000..4c6ee6f0 --- /dev/null +++ b/lib/guzzlehttp/psr7/src/Response.php @@ -0,0 +1,160 @@ + 'Continue', + 101 => 'Switching Protocols', + 102 => 'Processing', + 200 => 'OK', + 201 => 'Created', + 202 => 'Accepted', + 203 => 'Non-Authoritative Information', + 204 => 'No Content', + 205 => 'Reset Content', + 206 => 'Partial Content', + 207 => 'Multi-status', + 208 => 'Already Reported', + 300 => 'Multiple Choices', + 301 => 'Moved Permanently', + 302 => 'Found', + 303 => 'See Other', + 304 => 'Not Modified', + 305 => 'Use Proxy', + 306 => 'Switch Proxy', + 307 => 'Temporary Redirect', + 308 => 'Permanent Redirect', + 400 => 'Bad Request', + 401 => 'Unauthorized', + 402 => 'Payment Required', + 403 => 'Forbidden', + 404 => 'Not Found', + 405 => 'Method Not Allowed', + 406 => 'Not Acceptable', + 407 => 'Proxy Authentication Required', + 408 => 'Request Time-out', + 409 => 'Conflict', + 410 => 'Gone', + 411 => 'Length Required', + 412 => 'Precondition Failed', + 413 => 'Request Entity Too Large', + 414 => 'Request-URI Too Large', + 415 => 'Unsupported Media Type', + 416 => 'Requested range not satisfiable', + 417 => 'Expectation Failed', + 418 => 'I\'m a teapot', + 422 => 'Unprocessable Entity', + 423 => 'Locked', + 424 => 'Failed Dependency', + 425 => 'Unordered Collection', + 426 => 'Upgrade Required', + 428 => 'Precondition Required', + 429 => 'Too Many Requests', + 431 => 'Request Header Fields Too Large', + 451 => 'Unavailable For Legal Reasons', + 500 => 'Internal Server Error', + 501 => 'Not Implemented', + 502 => 'Bad Gateway', + 503 => 'Service Unavailable', + 504 => 'Gateway Time-out', + 505 => 'HTTP Version not supported', + 506 => 'Variant Also Negotiates', + 507 => 'Insufficient Storage', + 508 => 'Loop Detected', + 510 => 'Not Extended', + 511 => 'Network Authentication Required', + ]; + + /** @var string */ + private $reasonPhrase; + + /** @var int */ + private $statusCode; + + /** + * @param int $status Status code + * @param array $headers Response headers + * @param string|resource|StreamInterface|null $body Response body + * @param string $version Protocol version + * @param string|null $reason Reason phrase (when empty a default will be used based on the status code) + */ + public function __construct( + int $status = 200, + array $headers = [], + $body = null, + string $version = '1.1', + string $reason = null + ) { + $this->assertStatusCodeRange($status); + + $this->statusCode = $status; + + if ($body !== '' && $body !== null) { + $this->stream = Utils::streamFor($body); + } + + $this->setHeaders($headers); + if ($reason == '' && isset(self::PHRASES[$this->statusCode])) { + $this->reasonPhrase = self::PHRASES[$this->statusCode]; + } else { + $this->reasonPhrase = (string) $reason; + } + + $this->protocol = $version; + } + + public function getStatusCode(): int + { + return $this->statusCode; + } + + public function getReasonPhrase(): string + { + return $this->reasonPhrase; + } + + public function withStatus($code, $reasonPhrase = ''): ResponseInterface + { + $this->assertStatusCodeIsInteger($code); + $code = (int) $code; + $this->assertStatusCodeRange($code); + + $new = clone $this; + $new->statusCode = $code; + if ($reasonPhrase == '' && isset(self::PHRASES[$new->statusCode])) { + $reasonPhrase = self::PHRASES[$new->statusCode]; + } + $new->reasonPhrase = (string) $reasonPhrase; + return $new; + } + + /** + * @param mixed $statusCode + */ + private function assertStatusCodeIsInteger($statusCode): void + { + if (filter_var($statusCode, FILTER_VALIDATE_INT) === false) { + throw new \InvalidArgumentException('Status code must be an integer value.'); + } + } + + private function assertStatusCodeRange(int $statusCode): void + { + if ($statusCode < 100 || $statusCode >= 600) { + throw new \InvalidArgumentException('Status code must be an integer value between 1xx and 5xx.'); + } + } +} diff --git a/lib/guzzlehttp/psr7/src/Rfc7230.php b/lib/guzzlehttp/psr7/src/Rfc7230.php new file mode 100644 index 00000000..30224018 --- /dev/null +++ b/lib/guzzlehttp/psr7/src/Rfc7230.php @@ -0,0 +1,23 @@ +@,;:\\\"/[\]?={}\x01-\x20\x7F]++):[ \t]*+((?:[ \t]*+[\x21-\x7E\x80-\xFF]++)*+)[ \t]*+\r?\n)m"; + public const HEADER_FOLD_REGEX = "(\r?\n[ \t]++)"; +} diff --git a/lib/guzzlehttp/psr7/src/ServerRequest.php b/lib/guzzlehttp/psr7/src/ServerRequest.php new file mode 100644 index 00000000..6ae3f9be --- /dev/null +++ b/lib/guzzlehttp/psr7/src/ServerRequest.php @@ -0,0 +1,344 @@ + $headers Request headers + * @param string|resource|StreamInterface|null $body Request body + * @param string $version Protocol version + * @param array $serverParams Typically the $_SERVER superglobal + */ + public function __construct( + string $method, + $uri, + array $headers = [], + $body = null, + string $version = '1.1', + array $serverParams = [] + ) { + $this->serverParams = $serverParams; + + parent::__construct($method, $uri, $headers, $body, $version); + } + + /** + * Return an UploadedFile instance array. + * + * @param array $files A array which respect $_FILES structure + * + * @throws InvalidArgumentException for unrecognized values + */ + public static function normalizeFiles(array $files): array + { + $normalized = []; + + foreach ($files as $key => $value) { + if ($value instanceof UploadedFileInterface) { + $normalized[$key] = $value; + } elseif (is_array($value) && isset($value['tmp_name'])) { + $normalized[$key] = self::createUploadedFileFromSpec($value); + } elseif (is_array($value)) { + $normalized[$key] = self::normalizeFiles($value); + continue; + } else { + throw new InvalidArgumentException('Invalid value in files specification'); + } + } + + return $normalized; + } + + /** + * Create and return an UploadedFile instance from a $_FILES specification. + * + * If the specification represents an array of values, this method will + * delegate to normalizeNestedFileSpec() and return that return value. + * + * @param array $value $_FILES struct + * + * @return UploadedFileInterface|UploadedFileInterface[] + */ + private static function createUploadedFileFromSpec(array $value) + { + if (is_array($value['tmp_name'])) { + return self::normalizeNestedFileSpec($value); + } + + return new UploadedFile( + $value['tmp_name'], + (int) $value['size'], + (int) $value['error'], + $value['name'], + $value['type'] + ); + } + + /** + * Normalize an array of file specifications. + * + * Loops through all nested files and returns a normalized array of + * UploadedFileInterface instances. + * + * @return UploadedFileInterface[] + */ + private static function normalizeNestedFileSpec(array $files = []): array + { + $normalizedFiles = []; + + foreach (array_keys($files['tmp_name']) as $key) { + $spec = [ + 'tmp_name' => $files['tmp_name'][$key], + 'size' => $files['size'][$key], + 'error' => $files['error'][$key], + 'name' => $files['name'][$key], + 'type' => $files['type'][$key], + ]; + $normalizedFiles[$key] = self::createUploadedFileFromSpec($spec); + } + + return $normalizedFiles; + } + + /** + * Return a ServerRequest populated with superglobals: + * $_GET + * $_POST + * $_COOKIE + * $_FILES + * $_SERVER + */ + public static function fromGlobals(): ServerRequestInterface + { + $method = $_SERVER['REQUEST_METHOD'] ?? 'GET'; + $headers = getallheaders(); + $uri = self::getUriFromGlobals(); + $body = new CachingStream(new LazyOpenStream('php://input', 'r+')); + $protocol = isset($_SERVER['SERVER_PROTOCOL']) ? str_replace('HTTP/', '', $_SERVER['SERVER_PROTOCOL']) : '1.1'; + + $serverRequest = new ServerRequest($method, $uri, $headers, $body, $protocol, $_SERVER); + + return $serverRequest + ->withCookieParams($_COOKIE) + ->withQueryParams($_GET) + ->withParsedBody($_POST) + ->withUploadedFiles(self::normalizeFiles($_FILES)); + } + + private static function extractHostAndPortFromAuthority(string $authority): array + { + $uri = 'http://' . $authority; + $parts = parse_url($uri); + if (false === $parts) { + return [null, null]; + } + + $host = $parts['host'] ?? null; + $port = $parts['port'] ?? null; + + return [$host, $port]; + } + + /** + * Get a Uri populated with values from $_SERVER. + */ + public static function getUriFromGlobals(): UriInterface + { + $uri = new Uri(''); + + $uri = $uri->withScheme(!empty($_SERVER['HTTPS']) && $_SERVER['HTTPS'] !== 'off' ? 'https' : 'http'); + + $hasPort = false; + if (isset($_SERVER['HTTP_HOST'])) { + [$host, $port] = self::extractHostAndPortFromAuthority($_SERVER['HTTP_HOST']); + if ($host !== null) { + $uri = $uri->withHost($host); + } + + if ($port !== null) { + $hasPort = true; + $uri = $uri->withPort($port); + } + } elseif (isset($_SERVER['SERVER_NAME'])) { + $uri = $uri->withHost($_SERVER['SERVER_NAME']); + } elseif (isset($_SERVER['SERVER_ADDR'])) { + $uri = $uri->withHost($_SERVER['SERVER_ADDR']); + } + + if (!$hasPort && isset($_SERVER['SERVER_PORT'])) { + $uri = $uri->withPort($_SERVER['SERVER_PORT']); + } + + $hasQuery = false; + if (isset($_SERVER['REQUEST_URI'])) { + $requestUriParts = explode('?', $_SERVER['REQUEST_URI'], 2); + $uri = $uri->withPath($requestUriParts[0]); + if (isset($requestUriParts[1])) { + $hasQuery = true; + $uri = $uri->withQuery($requestUriParts[1]); + } + } + + if (!$hasQuery && isset($_SERVER['QUERY_STRING'])) { + $uri = $uri->withQuery($_SERVER['QUERY_STRING']); + } + + return $uri; + } + + public function getServerParams(): array + { + return $this->serverParams; + } + + public function getUploadedFiles(): array + { + return $this->uploadedFiles; + } + + public function withUploadedFiles(array $uploadedFiles): ServerRequestInterface + { + $new = clone $this; + $new->uploadedFiles = $uploadedFiles; + + return $new; + } + + public function getCookieParams(): array + { + return $this->cookieParams; + } + + public function withCookieParams(array $cookies): ServerRequestInterface + { + $new = clone $this; + $new->cookieParams = $cookies; + + return $new; + } + + public function getQueryParams(): array + { + return $this->queryParams; + } + + public function withQueryParams(array $query): ServerRequestInterface + { + $new = clone $this; + $new->queryParams = $query; + + return $new; + } + + /** + * {@inheritdoc} + * + * @return array|object|null + */ + public function getParsedBody() + { + return $this->parsedBody; + } + + public function withParsedBody($data): ServerRequestInterface + { + $new = clone $this; + $new->parsedBody = $data; + + return $new; + } + + public function getAttributes(): array + { + return $this->attributes; + } + + /** + * {@inheritdoc} + * + * @return mixed + */ + public function getAttribute($attribute, $default = null) + { + if (false === array_key_exists($attribute, $this->attributes)) { + return $default; + } + + return $this->attributes[$attribute]; + } + + public function withAttribute($attribute, $value): ServerRequestInterface + { + $new = clone $this; + $new->attributes[$attribute] = $value; + + return $new; + } + + public function withoutAttribute($attribute): ServerRequestInterface + { + if (false === array_key_exists($attribute, $this->attributes)) { + return $this; + } + + $new = clone $this; + unset($new->attributes[$attribute]); + + return $new; + } +} diff --git a/lib/guzzlehttp/psr7/src/Stream.php b/lib/guzzlehttp/psr7/src/Stream.php new file mode 100644 index 00000000..d389427c --- /dev/null +++ b/lib/guzzlehttp/psr7/src/Stream.php @@ -0,0 +1,279 @@ +size = $options['size']; + } + + $this->customMetadata = $options['metadata'] ?? []; + $this->stream = $stream; + $meta = stream_get_meta_data($this->stream); + $this->seekable = $meta['seekable']; + $this->readable = (bool)preg_match(self::READABLE_MODES, $meta['mode']); + $this->writable = (bool)preg_match(self::WRITABLE_MODES, $meta['mode']); + $this->uri = $this->getMetadata('uri'); + } + + /** + * Closes the stream when the destructed + */ + public function __destruct() + { + $this->close(); + } + + public function __toString(): string + { + try { + if ($this->isSeekable()) { + $this->seek(0); + } + return $this->getContents(); + } catch (\Throwable $e) { + if (\PHP_VERSION_ID >= 70400) { + throw $e; + } + trigger_error(sprintf('%s::__toString exception: %s', self::class, (string) $e), E_USER_ERROR); + return ''; + } + } + + public function getContents(): string + { + if (!isset($this->stream)) { + throw new \RuntimeException('Stream is detached'); + } + + $contents = stream_get_contents($this->stream); + + if ($contents === false) { + throw new \RuntimeException('Unable to read stream contents'); + } + + return $contents; + } + + public function close(): void + { + if (isset($this->stream)) { + if (is_resource($this->stream)) { + fclose($this->stream); + } + $this->detach(); + } + } + + public function detach() + { + if (!isset($this->stream)) { + return null; + } + + $result = $this->stream; + unset($this->stream); + $this->size = $this->uri = null; + $this->readable = $this->writable = $this->seekable = false; + + return $result; + } + + public function getSize(): ?int + { + if ($this->size !== null) { + return $this->size; + } + + if (!isset($this->stream)) { + return null; + } + + // Clear the stat cache if the stream has a URI + if ($this->uri) { + clearstatcache(true, $this->uri); + } + + $stats = fstat($this->stream); + if (is_array($stats) && isset($stats['size'])) { + $this->size = $stats['size']; + return $this->size; + } + + return null; + } + + public function isReadable(): bool + { + return $this->readable; + } + + public function isWritable(): bool + { + return $this->writable; + } + + public function isSeekable(): bool + { + return $this->seekable; + } + + public function eof(): bool + { + if (!isset($this->stream)) { + throw new \RuntimeException('Stream is detached'); + } + + return feof($this->stream); + } + + public function tell(): int + { + if (!isset($this->stream)) { + throw new \RuntimeException('Stream is detached'); + } + + $result = ftell($this->stream); + + if ($result === false) { + throw new \RuntimeException('Unable to determine stream position'); + } + + return $result; + } + + public function rewind(): void + { + $this->seek(0); + } + + public function seek($offset, $whence = SEEK_SET): void + { + $whence = (int) $whence; + + if (!isset($this->stream)) { + throw new \RuntimeException('Stream is detached'); + } + if (!$this->seekable) { + throw new \RuntimeException('Stream is not seekable'); + } + if (fseek($this->stream, $offset, $whence) === -1) { + throw new \RuntimeException('Unable to seek to stream position ' + . $offset . ' with whence ' . var_export($whence, true)); + } + } + + public function read($length): string + { + if (!isset($this->stream)) { + throw new \RuntimeException('Stream is detached'); + } + if (!$this->readable) { + throw new \RuntimeException('Cannot read from non-readable stream'); + } + if ($length < 0) { + throw new \RuntimeException('Length parameter cannot be negative'); + } + + if (0 === $length) { + return ''; + } + + $string = fread($this->stream, $length); + if (false === $string) { + throw new \RuntimeException('Unable to read from stream'); + } + + return $string; + } + + public function write($string): int + { + if (!isset($this->stream)) { + throw new \RuntimeException('Stream is detached'); + } + if (!$this->writable) { + throw new \RuntimeException('Cannot write to a non-writable stream'); + } + + // We can't know the size after writing anything + $this->size = null; + $result = fwrite($this->stream, $string); + + if ($result === false) { + throw new \RuntimeException('Unable to write to stream'); + } + + return $result; + } + + /** + * {@inheritdoc} + * + * @return mixed + */ + public function getMetadata($key = null) + { + if (!isset($this->stream)) { + return $key ? null : []; + } elseif (!$key) { + return $this->customMetadata + stream_get_meta_data($this->stream); + } elseif (isset($this->customMetadata[$key])) { + return $this->customMetadata[$key]; + } + + $meta = stream_get_meta_data($this->stream); + + return $meta[$key] ?? null; + } +} diff --git a/lib/guzzlehttp/psr7/src/StreamDecoratorTrait.php b/lib/guzzlehttp/psr7/src/StreamDecoratorTrait.php new file mode 100644 index 00000000..56d4104d --- /dev/null +++ b/lib/guzzlehttp/psr7/src/StreamDecoratorTrait.php @@ -0,0 +1,155 @@ +stream = $stream; + } + + /** + * Magic method used to create a new stream if streams are not added in + * the constructor of a decorator (e.g., LazyOpenStream). + * + * @return StreamInterface + */ + public function __get(string $name) + { + if ($name === 'stream') { + $this->stream = $this->createStream(); + return $this->stream; + } + + throw new \UnexpectedValueException("$name not found on class"); + } + + public function __toString(): string + { + try { + if ($this->isSeekable()) { + $this->seek(0); + } + return $this->getContents(); + } catch (\Throwable $e) { + if (\PHP_VERSION_ID >= 70400) { + throw $e; + } + trigger_error(sprintf('%s::__toString exception: %s', self::class, (string) $e), E_USER_ERROR); + return ''; + } + } + + public function getContents(): string + { + return Utils::copyToString($this); + } + + /** + * Allow decorators to implement custom methods + * + * @return mixed + */ + public function __call(string $method, array $args) + { + /** @var callable $callable */ + $callable = [$this->stream, $method]; + $result = call_user_func_array($callable, $args); + + // Always return the wrapped object if the result is a return $this + return $result === $this->stream ? $this : $result; + } + + public function close(): void + { + $this->stream->close(); + } + + /** + * {@inheritdoc} + * + * @return mixed + */ + public function getMetadata($key = null) + { + return $this->stream->getMetadata($key); + } + + public function detach() + { + return $this->stream->detach(); + } + + public function getSize(): ?int + { + return $this->stream->getSize(); + } + + public function eof(): bool + { + return $this->stream->eof(); + } + + public function tell(): int + { + return $this->stream->tell(); + } + + public function isReadable(): bool + { + return $this->stream->isReadable(); + } + + public function isWritable(): bool + { + return $this->stream->isWritable(); + } + + public function isSeekable(): bool + { + return $this->stream->isSeekable(); + } + + public function rewind(): void + { + $this->seek(0); + } + + public function seek($offset, $whence = SEEK_SET): void + { + $this->stream->seek($offset, $whence); + } + + public function read($length): string + { + return $this->stream->read($length); + } + + public function write($string): int + { + return $this->stream->write($string); + } + + /** + * Implement in subclasses to dynamically create streams when requested. + * + * @throws \BadMethodCallException + */ + protected function createStream(): StreamInterface + { + throw new \BadMethodCallException('Not implemented'); + } +} diff --git a/lib/guzzlehttp/psr7/src/StreamWrapper.php b/lib/guzzlehttp/psr7/src/StreamWrapper.php new file mode 100644 index 00000000..2a934640 --- /dev/null +++ b/lib/guzzlehttp/psr7/src/StreamWrapper.php @@ -0,0 +1,175 @@ +isReadable()) { + $mode = $stream->isWritable() ? 'r+' : 'r'; + } elseif ($stream->isWritable()) { + $mode = 'w'; + } else { + throw new \InvalidArgumentException('The stream must be readable, ' + . 'writable, or both.'); + } + + return fopen('guzzle://stream', $mode, false, self::createStreamContext($stream)); + } + + /** + * Creates a stream context that can be used to open a stream as a php stream resource. + * + * @return resource + */ + public static function createStreamContext(StreamInterface $stream) + { + return stream_context_create([ + 'guzzle' => ['stream' => $stream] + ]); + } + + /** + * Registers the stream wrapper if needed + */ + public static function register(): void + { + if (!in_array('guzzle', stream_get_wrappers())) { + stream_wrapper_register('guzzle', __CLASS__); + } + } + + public function stream_open(string $path, string $mode, int $options, string &$opened_path = null): bool + { + $options = stream_context_get_options($this->context); + + if (!isset($options['guzzle']['stream'])) { + return false; + } + + $this->mode = $mode; + $this->stream = $options['guzzle']['stream']; + + return true; + } + + public function stream_read(int $count): string + { + return $this->stream->read($count); + } + + public function stream_write(string $data): int + { + return $this->stream->write($data); + } + + public function stream_tell(): int + { + return $this->stream->tell(); + } + + public function stream_eof(): bool + { + return $this->stream->eof(); + } + + public function stream_seek(int $offset, int $whence): bool + { + $this->stream->seek($offset, $whence); + + return true; + } + + /** + * @return resource|false + */ + public function stream_cast(int $cast_as) + { + $stream = clone($this->stream); + $resource = $stream->detach(); + + return $resource ?? false; + } + + /** + * @return array + */ + public function stream_stat(): array + { + static $modeMap = [ + 'r' => 33060, + 'rb' => 33060, + 'r+' => 33206, + 'w' => 33188, + 'wb' => 33188 + ]; + + return [ + 'dev' => 0, + 'ino' => 0, + 'mode' => $modeMap[$this->mode], + 'nlink' => 0, + 'uid' => 0, + 'gid' => 0, + 'rdev' => 0, + 'size' => $this->stream->getSize() ?: 0, + 'atime' => 0, + 'mtime' => 0, + 'ctime' => 0, + 'blksize' => 0, + 'blocks' => 0 + ]; + } + + /** + * @return array + */ + public function url_stat(string $path, int $flags): array + { + return [ + 'dev' => 0, + 'ino' => 0, + 'mode' => 0, + 'nlink' => 0, + 'uid' => 0, + 'gid' => 0, + 'rdev' => 0, + 'size' => 0, + 'atime' => 0, + 'mtime' => 0, + 'ctime' => 0, + 'blksize' => 0, + 'blocks' => 0 + ]; + } +} diff --git a/lib/guzzlehttp/psr7/src/UploadedFile.php b/lib/guzzlehttp/psr7/src/UploadedFile.php new file mode 100644 index 00000000..b1521bcf --- /dev/null +++ b/lib/guzzlehttp/psr7/src/UploadedFile.php @@ -0,0 +1,211 @@ +setError($errorStatus); + $this->size = $size; + $this->clientFilename = $clientFilename; + $this->clientMediaType = $clientMediaType; + + if ($this->isOk()) { + $this->setStreamOrFile($streamOrFile); + } + } + + /** + * Depending on the value set file or stream variable + * + * @param StreamInterface|string|resource $streamOrFile + * + * @throws InvalidArgumentException + */ + private function setStreamOrFile($streamOrFile): void + { + if (is_string($streamOrFile)) { + $this->file = $streamOrFile; + } elseif (is_resource($streamOrFile)) { + $this->stream = new Stream($streamOrFile); + } elseif ($streamOrFile instanceof StreamInterface) { + $this->stream = $streamOrFile; + } else { + throw new InvalidArgumentException( + 'Invalid stream or file provided for UploadedFile' + ); + } + } + + /** + * @throws InvalidArgumentException + */ + private function setError(int $error): void + { + if (false === in_array($error, UploadedFile::ERRORS, true)) { + throw new InvalidArgumentException( + 'Invalid error status for UploadedFile' + ); + } + + $this->error = $error; + } + + private function isStringNotEmpty($param): bool + { + return is_string($param) && false === empty($param); + } + + /** + * Return true if there is no upload error + */ + private function isOk(): bool + { + return $this->error === UPLOAD_ERR_OK; + } + + public function isMoved(): bool + { + return $this->moved; + } + + /** + * @throws RuntimeException if is moved or not ok + */ + private function validateActive(): void + { + if (false === $this->isOk()) { + throw new RuntimeException('Cannot retrieve stream due to upload error'); + } + + if ($this->isMoved()) { + throw new RuntimeException('Cannot retrieve stream after it has already been moved'); + } + } + + public function getStream(): StreamInterface + { + $this->validateActive(); + + if ($this->stream instanceof StreamInterface) { + return $this->stream; + } + + /** @var string $file */ + $file = $this->file; + + return new LazyOpenStream($file, 'r+'); + } + + public function moveTo($targetPath): void + { + $this->validateActive(); + + if (false === $this->isStringNotEmpty($targetPath)) { + throw new InvalidArgumentException( + 'Invalid path provided for move operation; must be a non-empty string' + ); + } + + if ($this->file) { + $this->moved = PHP_SAPI === 'cli' + ? rename($this->file, $targetPath) + : move_uploaded_file($this->file, $targetPath); + } else { + Utils::copyToStream( + $this->getStream(), + new LazyOpenStream($targetPath, 'w') + ); + + $this->moved = true; + } + + if (false === $this->moved) { + throw new RuntimeException( + sprintf('Uploaded file could not be moved to %s', $targetPath) + ); + } + } + + public function getSize(): ?int + { + return $this->size; + } + + public function getError(): int + { + return $this->error; + } + + public function getClientFilename(): ?string + { + return $this->clientFilename; + } + + public function getClientMediaType(): ?string + { + return $this->clientMediaType; + } +} diff --git a/lib/guzzlehttp/psr7/src/Uri.php b/lib/guzzlehttp/psr7/src/Uri.php new file mode 100644 index 00000000..3898f783 --- /dev/null +++ b/lib/guzzlehttp/psr7/src/Uri.php @@ -0,0 +1,733 @@ + 80, + 'https' => 443, + 'ftp' => 21, + 'gopher' => 70, + 'nntp' => 119, + 'news' => 119, + 'telnet' => 23, + 'tn3270' => 23, + 'imap' => 143, + 'pop' => 110, + 'ldap' => 389, + ]; + + /** + * Unreserved characters for use in a regex. + * + * @link https://tools.ietf.org/html/rfc3986#section-2.3 + */ + private const CHAR_UNRESERVED = 'a-zA-Z0-9_\-\.~'; + + /** + * Sub-delims for use in a regex. + * + * @link https://tools.ietf.org/html/rfc3986#section-2.2 + */ + private const CHAR_SUB_DELIMS = '!\$&\'\(\)\*\+,;='; + private const QUERY_SEPARATORS_REPLACEMENT = ['=' => '%3D', '&' => '%26']; + + /** @var string Uri scheme. */ + private $scheme = ''; + + /** @var string Uri user info. */ + private $userInfo = ''; + + /** @var string Uri host. */ + private $host = ''; + + /** @var int|null Uri port. */ + private $port; + + /** @var string Uri path. */ + private $path = ''; + + /** @var string Uri query string. */ + private $query = ''; + + /** @var string Uri fragment. */ + private $fragment = ''; + + /** @var string|null String representation */ + private $composedComponents; + + public function __construct(string $uri = '') + { + if ($uri !== '') { + $parts = self::parse($uri); + if ($parts === false) { + throw new MalformedUriException("Unable to parse URI: $uri"); + } + $this->applyParts($parts); + } + } + /** + * UTF-8 aware \parse_url() replacement. + * + * The internal function produces broken output for non ASCII domain names + * (IDN) when used with locales other than "C". + * + * On the other hand, cURL understands IDN correctly only when UTF-8 locale + * is configured ("C.UTF-8", "en_US.UTF-8", etc.). + * + * @see https://bugs.php.net/bug.php?id=52923 + * @see https://www.php.net/manual/en/function.parse-url.php#114817 + * @see https://curl.haxx.se/libcurl/c/CURLOPT_URL.html#ENCODING + * + * @return array|false + */ + private static function parse(string $url) + { + // If IPv6 + $prefix = ''; + if (preg_match('%^(.*://\[[0-9:a-f]+\])(.*?)$%', $url, $matches)) { + /** @var array{0:string, 1:string, 2:string} $matches */ + $prefix = $matches[1]; + $url = $matches[2]; + } + + /** @var string */ + $encodedUrl = preg_replace_callback( + '%[^:/@?&=#]+%usD', + static function ($matches) { + return urlencode($matches[0]); + }, + $url + ); + + $result = parse_url($prefix . $encodedUrl); + + if ($result === false) { + return false; + } + + return array_map('urldecode', $result); + } + + public function __toString(): string + { + if ($this->composedComponents === null) { + $this->composedComponents = self::composeComponents( + $this->scheme, + $this->getAuthority(), + $this->path, + $this->query, + $this->fragment + ); + } + + return $this->composedComponents; + } + + /** + * Composes a URI reference string from its various components. + * + * Usually this method does not need to be called manually but instead is used indirectly via + * `Psr\Http\Message\UriInterface::__toString`. + * + * PSR-7 UriInterface treats an empty component the same as a missing component as + * getQuery(), getFragment() etc. always return a string. This explains the slight + * difference to RFC 3986 Section 5.3. + * + * Another adjustment is that the authority separator is added even when the authority is missing/empty + * for the "file" scheme. This is because PHP stream functions like `file_get_contents` only work with + * `file:///myfile` but not with `file:/myfile` although they are equivalent according to RFC 3986. But + * `file:///` is the more common syntax for the file scheme anyway (Chrome for example redirects to + * that format). + * + * @link https://tools.ietf.org/html/rfc3986#section-5.3 + */ + public static function composeComponents(?string $scheme, ?string $authority, string $path, ?string $query, ?string $fragment): string + { + $uri = ''; + + // weak type checks to also accept null until we can add scalar type hints + if ($scheme != '') { + $uri .= $scheme . ':'; + } + + if ($authority != ''|| $scheme === 'file') { + $uri .= '//' . $authority; + } + + $uri .= $path; + + if ($query != '') { + $uri .= '?' . $query; + } + + if ($fragment != '') { + $uri .= '#' . $fragment; + } + + return $uri; + } + + /** + * Whether the URI has the default port of the current scheme. + * + * `Psr\Http\Message\UriInterface::getPort` may return null or the standard port. This method can be used + * independently of the implementation. + */ + public static function isDefaultPort(UriInterface $uri): bool + { + return $uri->getPort() === null + || (isset(self::DEFAULT_PORTS[$uri->getScheme()]) && $uri->getPort() === self::DEFAULT_PORTS[$uri->getScheme()]); + } + + /** + * Whether the URI is absolute, i.e. it has a scheme. + * + * An instance of UriInterface can either be an absolute URI or a relative reference. This method returns true + * if it is the former. An absolute URI has a scheme. A relative reference is used to express a URI relative + * to another URI, the base URI. Relative references can be divided into several forms: + * - network-path references, e.g. '//example.com/path' + * - absolute-path references, e.g. '/path' + * - relative-path references, e.g. 'subpath' + * + * @see Uri::isNetworkPathReference + * @see Uri::isAbsolutePathReference + * @see Uri::isRelativePathReference + * @link https://tools.ietf.org/html/rfc3986#section-4 + */ + public static function isAbsolute(UriInterface $uri): bool + { + return $uri->getScheme() !== ''; + } + + /** + * Whether the URI is a network-path reference. + * + * A relative reference that begins with two slash characters is termed an network-path reference. + * + * @link https://tools.ietf.org/html/rfc3986#section-4.2 + */ + public static function isNetworkPathReference(UriInterface $uri): bool + { + return $uri->getScheme() === '' && $uri->getAuthority() !== ''; + } + + /** + * Whether the URI is a absolute-path reference. + * + * A relative reference that begins with a single slash character is termed an absolute-path reference. + * + * @link https://tools.ietf.org/html/rfc3986#section-4.2 + */ + public static function isAbsolutePathReference(UriInterface $uri): bool + { + return $uri->getScheme() === '' + && $uri->getAuthority() === '' + && isset($uri->getPath()[0]) + && $uri->getPath()[0] === '/'; + } + + /** + * Whether the URI is a relative-path reference. + * + * A relative reference that does not begin with a slash character is termed a relative-path reference. + * + * @link https://tools.ietf.org/html/rfc3986#section-4.2 + */ + public static function isRelativePathReference(UriInterface $uri): bool + { + return $uri->getScheme() === '' + && $uri->getAuthority() === '' + && (!isset($uri->getPath()[0]) || $uri->getPath()[0] !== '/'); + } + + /** + * Whether the URI is a same-document reference. + * + * A same-document reference refers to a URI that is, aside from its fragment + * component, identical to the base URI. When no base URI is given, only an empty + * URI reference (apart from its fragment) is considered a same-document reference. + * + * @param UriInterface $uri The URI to check + * @param UriInterface|null $base An optional base URI to compare against + * + * @link https://tools.ietf.org/html/rfc3986#section-4.4 + */ + public static function isSameDocumentReference(UriInterface $uri, UriInterface $base = null): bool + { + if ($base !== null) { + $uri = UriResolver::resolve($base, $uri); + + return ($uri->getScheme() === $base->getScheme()) + && ($uri->getAuthority() === $base->getAuthority()) + && ($uri->getPath() === $base->getPath()) + && ($uri->getQuery() === $base->getQuery()); + } + + return $uri->getScheme() === '' && $uri->getAuthority() === '' && $uri->getPath() === '' && $uri->getQuery() === ''; + } + + /** + * Creates a new URI with a specific query string value removed. + * + * Any existing query string values that exactly match the provided key are + * removed. + * + * @param UriInterface $uri URI to use as a base. + * @param string $key Query string key to remove. + */ + public static function withoutQueryValue(UriInterface $uri, string $key): UriInterface + { + $result = self::getFilteredQueryString($uri, [$key]); + + return $uri->withQuery(implode('&', $result)); + } + + /** + * Creates a new URI with a specific query string value. + * + * Any existing query string values that exactly match the provided key are + * removed and replaced with the given key value pair. + * + * A value of null will set the query string key without a value, e.g. "key" + * instead of "key=value". + * + * @param UriInterface $uri URI to use as a base. + * @param string $key Key to set. + * @param string|null $value Value to set + */ + public static function withQueryValue(UriInterface $uri, string $key, ?string $value): UriInterface + { + $result = self::getFilteredQueryString($uri, [$key]); + + $result[] = self::generateQueryString($key, $value); + + return $uri->withQuery(implode('&', $result)); + } + + /** + * Creates a new URI with multiple specific query string values. + * + * It has the same behavior as withQueryValue() but for an associative array of key => value. + * + * @param UriInterface $uri URI to use as a base. + * @param array $keyValueArray Associative array of key and values + */ + public static function withQueryValues(UriInterface $uri, array $keyValueArray): UriInterface + { + $result = self::getFilteredQueryString($uri, array_keys($keyValueArray)); + + foreach ($keyValueArray as $key => $value) { + $result[] = self::generateQueryString((string) $key, $value !== null ? (string) $value : null); + } + + return $uri->withQuery(implode('&', $result)); + } + + /** + * Creates a URI from a hash of `parse_url` components. + * + * @link http://php.net/manual/en/function.parse-url.php + * + * @throws MalformedUriException If the components do not form a valid URI. + */ + public static function fromParts(array $parts): UriInterface + { + $uri = new self(); + $uri->applyParts($parts); + $uri->validateState(); + + return $uri; + } + + public function getScheme(): string + { + return $this->scheme; + } + + public function getAuthority(): string + { + $authority = $this->host; + if ($this->userInfo !== '') { + $authority = $this->userInfo . '@' . $authority; + } + + if ($this->port !== null) { + $authority .= ':' . $this->port; + } + + return $authority; + } + + public function getUserInfo(): string + { + return $this->userInfo; + } + + public function getHost(): string + { + return $this->host; + } + + public function getPort(): ?int + { + return $this->port; + } + + public function getPath(): string + { + return $this->path; + } + + public function getQuery(): string + { + return $this->query; + } + + public function getFragment(): string + { + return $this->fragment; + } + + public function withScheme($scheme): UriInterface + { + $scheme = $this->filterScheme($scheme); + + if ($this->scheme === $scheme) { + return $this; + } + + $new = clone $this; + $new->scheme = $scheme; + $new->composedComponents = null; + $new->removeDefaultPort(); + $new->validateState(); + + return $new; + } + + public function withUserInfo($user, $password = null): UriInterface + { + $info = $this->filterUserInfoComponent($user); + if ($password !== null) { + $info .= ':' . $this->filterUserInfoComponent($password); + } + + if ($this->userInfo === $info) { + return $this; + } + + $new = clone $this; + $new->userInfo = $info; + $new->composedComponents = null; + $new->validateState(); + + return $new; + } + + public function withHost($host): UriInterface + { + $host = $this->filterHost($host); + + if ($this->host === $host) { + return $this; + } + + $new = clone $this; + $new->host = $host; + $new->composedComponents = null; + $new->validateState(); + + return $new; + } + + public function withPort($port): UriInterface + { + $port = $this->filterPort($port); + + if ($this->port === $port) { + return $this; + } + + $new = clone $this; + $new->port = $port; + $new->composedComponents = null; + $new->removeDefaultPort(); + $new->validateState(); + + return $new; + } + + public function withPath($path): UriInterface + { + $path = $this->filterPath($path); + + if ($this->path === $path) { + return $this; + } + + $new = clone $this; + $new->path = $path; + $new->composedComponents = null; + $new->validateState(); + + return $new; + } + + public function withQuery($query): UriInterface + { + $query = $this->filterQueryAndFragment($query); + + if ($this->query === $query) { + return $this; + } + + $new = clone $this; + $new->query = $query; + $new->composedComponents = null; + + return $new; + } + + public function withFragment($fragment): UriInterface + { + $fragment = $this->filterQueryAndFragment($fragment); + + if ($this->fragment === $fragment) { + return $this; + } + + $new = clone $this; + $new->fragment = $fragment; + $new->composedComponents = null; + + return $new; + } + + /** + * Apply parse_url parts to a URI. + * + * @param array $parts Array of parse_url parts to apply. + */ + private function applyParts(array $parts): void + { + $this->scheme = isset($parts['scheme']) + ? $this->filterScheme($parts['scheme']) + : ''; + $this->userInfo = isset($parts['user']) + ? $this->filterUserInfoComponent($parts['user']) + : ''; + $this->host = isset($parts['host']) + ? $this->filterHost($parts['host']) + : ''; + $this->port = isset($parts['port']) + ? $this->filterPort($parts['port']) + : null; + $this->path = isset($parts['path']) + ? $this->filterPath($parts['path']) + : ''; + $this->query = isset($parts['query']) + ? $this->filterQueryAndFragment($parts['query']) + : ''; + $this->fragment = isset($parts['fragment']) + ? $this->filterQueryAndFragment($parts['fragment']) + : ''; + if (isset($parts['pass'])) { + $this->userInfo .= ':' . $this->filterUserInfoComponent($parts['pass']); + } + + $this->removeDefaultPort(); + } + + /** + * @param mixed $scheme + * + * @throws \InvalidArgumentException If the scheme is invalid. + */ + private function filterScheme($scheme): string + { + if (!is_string($scheme)) { + throw new \InvalidArgumentException('Scheme must be a string'); + } + + return \strtr($scheme, 'ABCDEFGHIJKLMNOPQRSTUVWXYZ', 'abcdefghijklmnopqrstuvwxyz'); + } + + /** + * @param mixed $component + * + * @throws \InvalidArgumentException If the user info is invalid. + */ + private function filterUserInfoComponent($component): string + { + if (!is_string($component)) { + throw new \InvalidArgumentException('User info must be a string'); + } + + return preg_replace_callback( + '/(?:[^%' . self::CHAR_UNRESERVED . self::CHAR_SUB_DELIMS . ']+|%(?![A-Fa-f0-9]{2}))/', + [$this, 'rawurlencodeMatchZero'], + $component + ); + } + + /** + * @param mixed $host + * + * @throws \InvalidArgumentException If the host is invalid. + */ + private function filterHost($host): string + { + if (!is_string($host)) { + throw new \InvalidArgumentException('Host must be a string'); + } + + return \strtr($host, 'ABCDEFGHIJKLMNOPQRSTUVWXYZ', 'abcdefghijklmnopqrstuvwxyz'); + } + + /** + * @param mixed $port + * + * @throws \InvalidArgumentException If the port is invalid. + */ + private function filterPort($port): ?int + { + if ($port === null) { + return null; + } + + $port = (int) $port; + if (0 > $port || 0xffff < $port) { + throw new \InvalidArgumentException( + sprintf('Invalid port: %d. Must be between 0 and 65535', $port) + ); + } + + return $port; + } + + /** + * @param string[] $keys + * + * @return string[] + */ + private static function getFilteredQueryString(UriInterface $uri, array $keys): array + { + $current = $uri->getQuery(); + + if ($current === '') { + return []; + } + + $decodedKeys = array_map('rawurldecode', $keys); + + return array_filter(explode('&', $current), function ($part) use ($decodedKeys) { + return !in_array(rawurldecode(explode('=', $part)[0]), $decodedKeys, true); + }); + } + + private static function generateQueryString(string $key, ?string $value): string + { + // Query string separators ("=", "&") within the key or value need to be encoded + // (while preventing double-encoding) before setting the query string. All other + // chars that need percent-encoding will be encoded by withQuery(). + $queryString = strtr($key, self::QUERY_SEPARATORS_REPLACEMENT); + + if ($value !== null) { + $queryString .= '=' . strtr($value, self::QUERY_SEPARATORS_REPLACEMENT); + } + + return $queryString; + } + + private function removeDefaultPort(): void + { + if ($this->port !== null && self::isDefaultPort($this)) { + $this->port = null; + } + } + + /** + * Filters the path of a URI + * + * @param mixed $path + * + * @throws \InvalidArgumentException If the path is invalid. + */ + private function filterPath($path): string + { + if (!is_string($path)) { + throw new \InvalidArgumentException('Path must be a string'); + } + + return preg_replace_callback( + '/(?:[^' . self::CHAR_UNRESERVED . self::CHAR_SUB_DELIMS . '%:@\/]++|%(?![A-Fa-f0-9]{2}))/', + [$this, 'rawurlencodeMatchZero'], + $path + ); + } + + /** + * Filters the query string or fragment of a URI. + * + * @param mixed $str + * + * @throws \InvalidArgumentException If the query or fragment is invalid. + */ + private function filterQueryAndFragment($str): string + { + if (!is_string($str)) { + throw new \InvalidArgumentException('Query and fragment must be a string'); + } + + return preg_replace_callback( + '/(?:[^' . self::CHAR_UNRESERVED . self::CHAR_SUB_DELIMS . '%:@\/\?]++|%(?![A-Fa-f0-9]{2}))/', + [$this, 'rawurlencodeMatchZero'], + $str + ); + } + + private function rawurlencodeMatchZero(array $match): string + { + return rawurlencode($match[0]); + } + + private function validateState(): void + { + if ($this->host === '' && ($this->scheme === 'http' || $this->scheme === 'https')) { + $this->host = self::HTTP_DEFAULT_HOST; + } + + if ($this->getAuthority() === '') { + if (0 === strpos($this->path, '//')) { + throw new MalformedUriException('The path of a URI without an authority must not start with two slashes "//"'); + } + if ($this->scheme === '' && false !== strpos(explode('/', $this->path, 2)[0], ':')) { + throw new MalformedUriException('A relative URI must not have a path beginning with a segment containing a colon'); + } + } elseif (isset($this->path[0]) && $this->path[0] !== '/') { + throw new MalformedUriException('The path of a URI with an authority must start with a slash "/" or be empty'); + } + } +} diff --git a/lib/guzzlehttp/psr7/src/UriNormalizer.php b/lib/guzzlehttp/psr7/src/UriNormalizer.php new file mode 100644 index 00000000..e12971ed --- /dev/null +++ b/lib/guzzlehttp/psr7/src/UriNormalizer.php @@ -0,0 +1,220 @@ +getPath() === '' && + ($uri->getScheme() === 'http' || $uri->getScheme() === 'https') + ) { + $uri = $uri->withPath('/'); + } + + if ($flags & self::REMOVE_DEFAULT_HOST && $uri->getScheme() === 'file' && $uri->getHost() === 'localhost') { + $uri = $uri->withHost(''); + } + + if ($flags & self::REMOVE_DEFAULT_PORT && $uri->getPort() !== null && Uri::isDefaultPort($uri)) { + $uri = $uri->withPort(null); + } + + if ($flags & self::REMOVE_DOT_SEGMENTS && !Uri::isRelativePathReference($uri)) { + $uri = $uri->withPath(UriResolver::removeDotSegments($uri->getPath())); + } + + if ($flags & self::REMOVE_DUPLICATE_SLASHES) { + $uri = $uri->withPath(preg_replace('#//++#', '/', $uri->getPath())); + } + + if ($flags & self::SORT_QUERY_PARAMETERS && $uri->getQuery() !== '') { + $queryKeyValues = explode('&', $uri->getQuery()); + sort($queryKeyValues); + $uri = $uri->withQuery(implode('&', $queryKeyValues)); + } + + return $uri; + } + + /** + * Whether two URIs can be considered equivalent. + * + * Both URIs are normalized automatically before comparison with the given $normalizations bitmask. The method also + * accepts relative URI references and returns true when they are equivalent. This of course assumes they will be + * resolved against the same base URI. If this is not the case, determination of equivalence or difference of + * relative references does not mean anything. + * + * @param UriInterface $uri1 An URI to compare + * @param UriInterface $uri2 An URI to compare + * @param int $normalizations A bitmask of normalizations to apply, see constants + * + * @link https://tools.ietf.org/html/rfc3986#section-6.1 + */ + public static function isEquivalent(UriInterface $uri1, UriInterface $uri2, int $normalizations = self::PRESERVING_NORMALIZATIONS): bool + { + return (string) self::normalize($uri1, $normalizations) === (string) self::normalize($uri2, $normalizations); + } + + private static function capitalizePercentEncoding(UriInterface $uri): UriInterface + { + $regex = '/(?:%[A-Fa-f0-9]{2})++/'; + + $callback = function (array $match) { + return strtoupper($match[0]); + }; + + return + $uri->withPath( + preg_replace_callback($regex, $callback, $uri->getPath()) + )->withQuery( + preg_replace_callback($regex, $callback, $uri->getQuery()) + ); + } + + private static function decodeUnreservedCharacters(UriInterface $uri): UriInterface + { + $regex = '/%(?:2D|2E|5F|7E|3[0-9]|[46][1-9A-F]|[57][0-9A])/i'; + + $callback = function (array $match) { + return rawurldecode($match[0]); + }; + + return + $uri->withPath( + preg_replace_callback($regex, $callback, $uri->getPath()) + )->withQuery( + preg_replace_callback($regex, $callback, $uri->getQuery()) + ); + } + + private function __construct() + { + // cannot be instantiated + } +} diff --git a/lib/guzzlehttp/psr7/src/UriResolver.php b/lib/guzzlehttp/psr7/src/UriResolver.php new file mode 100644 index 00000000..426e5c9a --- /dev/null +++ b/lib/guzzlehttp/psr7/src/UriResolver.php @@ -0,0 +1,211 @@ +getScheme() != '') { + return $rel->withPath(self::removeDotSegments($rel->getPath())); + } + + if ($rel->getAuthority() != '') { + $targetAuthority = $rel->getAuthority(); + $targetPath = self::removeDotSegments($rel->getPath()); + $targetQuery = $rel->getQuery(); + } else { + $targetAuthority = $base->getAuthority(); + if ($rel->getPath() === '') { + $targetPath = $base->getPath(); + $targetQuery = $rel->getQuery() != '' ? $rel->getQuery() : $base->getQuery(); + } else { + if ($rel->getPath()[0] === '/') { + $targetPath = $rel->getPath(); + } else { + if ($targetAuthority != '' && $base->getPath() === '') { + $targetPath = '/' . $rel->getPath(); + } else { + $lastSlashPos = strrpos($base->getPath(), '/'); + if ($lastSlashPos === false) { + $targetPath = $rel->getPath(); + } else { + $targetPath = substr($base->getPath(), 0, $lastSlashPos + 1) . $rel->getPath(); + } + } + } + $targetPath = self::removeDotSegments($targetPath); + $targetQuery = $rel->getQuery(); + } + } + + return new Uri(Uri::composeComponents( + $base->getScheme(), + $targetAuthority, + $targetPath, + $targetQuery, + $rel->getFragment() + )); + } + + /** + * Returns the target URI as a relative reference from the base URI. + * + * This method is the counterpart to resolve(): + * + * (string) $target === (string) UriResolver::resolve($base, UriResolver::relativize($base, $target)) + * + * One use-case is to use the current request URI as base URI and then generate relative links in your documents + * to reduce the document size or offer self-contained downloadable document archives. + * + * $base = new Uri('http://example.com/a/b/'); + * echo UriResolver::relativize($base, new Uri('http://example.com/a/b/c')); // prints 'c'. + * echo UriResolver::relativize($base, new Uri('http://example.com/a/x/y')); // prints '../x/y'. + * echo UriResolver::relativize($base, new Uri('http://example.com/a/b/?q')); // prints '?q'. + * echo UriResolver::relativize($base, new Uri('http://example.org/a/b/')); // prints '//example.org/a/b/'. + * + * This method also accepts a target that is already relative and will try to relativize it further. Only a + * relative-path reference will be returned as-is. + * + * echo UriResolver::relativize($base, new Uri('/a/b/c')); // prints 'c' as well + */ + public static function relativize(UriInterface $base, UriInterface $target): UriInterface + { + if ($target->getScheme() !== '' && + ($base->getScheme() !== $target->getScheme() || $target->getAuthority() === '' && $base->getAuthority() !== '') + ) { + return $target; + } + + if (Uri::isRelativePathReference($target)) { + // As the target is already highly relative we return it as-is. It would be possible to resolve + // the target with `$target = self::resolve($base, $target);` and then try make it more relative + // by removing a duplicate query. But let's not do that automatically. + return $target; + } + + if ($target->getAuthority() !== '' && $base->getAuthority() !== $target->getAuthority()) { + return $target->withScheme(''); + } + + // We must remove the path before removing the authority because if the path starts with two slashes, the URI + // would turn invalid. And we also cannot set a relative path before removing the authority, as that is also + // invalid. + $emptyPathUri = $target->withScheme('')->withPath('')->withUserInfo('')->withPort(null)->withHost(''); + + if ($base->getPath() !== $target->getPath()) { + return $emptyPathUri->withPath(self::getRelativePath($base, $target)); + } + + if ($base->getQuery() === $target->getQuery()) { + // Only the target fragment is left. And it must be returned even if base and target fragment are the same. + return $emptyPathUri->withQuery(''); + } + + // If the base URI has a query but the target has none, we cannot return an empty path reference as it would + // inherit the base query component when resolving. + if ($target->getQuery() === '') { + $segments = explode('/', $target->getPath()); + /** @var string $lastSegment */ + $lastSegment = end($segments); + + return $emptyPathUri->withPath($lastSegment === '' ? './' : $lastSegment); + } + + return $emptyPathUri; + } + + private static function getRelativePath(UriInterface $base, UriInterface $target): string + { + $sourceSegments = explode('/', $base->getPath()); + $targetSegments = explode('/', $target->getPath()); + array_pop($sourceSegments); + $targetLastSegment = array_pop($targetSegments); + foreach ($sourceSegments as $i => $segment) { + if (isset($targetSegments[$i]) && $segment === $targetSegments[$i]) { + unset($sourceSegments[$i], $targetSegments[$i]); + } else { + break; + } + } + $targetSegments[] = $targetLastSegment; + $relativePath = str_repeat('../', count($sourceSegments)) . implode('/', $targetSegments); + + // A reference to am empty last segment or an empty first sub-segment must be prefixed with "./". + // This also applies to a segment with a colon character (e.g., "file:colon") that cannot be used + // as the first segment of a relative-path reference, as it would be mistaken for a scheme name. + if ('' === $relativePath || false !== strpos(explode('/', $relativePath, 2)[0], ':')) { + $relativePath = "./$relativePath"; + } elseif ('/' === $relativePath[0]) { + if ($base->getAuthority() != '' && $base->getPath() === '') { + // In this case an extra slash is added by resolve() automatically. So we must not add one here. + $relativePath = ".$relativePath"; + } else { + $relativePath = "./$relativePath"; + } + } + + return $relativePath; + } + + private function __construct() + { + // cannot be instantiated + } +} diff --git a/lib/guzzlehttp/psr7/src/Utils.php b/lib/guzzlehttp/psr7/src/Utils.php new file mode 100644 index 00000000..6cc04ee4 --- /dev/null +++ b/lib/guzzlehttp/psr7/src/Utils.php @@ -0,0 +1,412 @@ + $v) { + if (!is_string($k) || !in_array(strtolower($k), $keys)) { + $result[$k] = $v; + } + } + + return $result; + } + + /** + * Copy the contents of a stream into another stream until the given number + * of bytes have been read. + * + * @param StreamInterface $source Stream to read from + * @param StreamInterface $dest Stream to write to + * @param int $maxLen Maximum number of bytes to read. Pass -1 + * to read the entire stream. + * + * @throws \RuntimeException on error. + */ + public static function copyToStream(StreamInterface $source, StreamInterface $dest, int $maxLen = -1): void + { + $bufferSize = 8192; + + if ($maxLen === -1) { + while (!$source->eof()) { + if (!$dest->write($source->read($bufferSize))) { + break; + } + } + } else { + $remaining = $maxLen; + while ($remaining > 0 && !$source->eof()) { + $buf = $source->read(min($bufferSize, $remaining)); + $len = strlen($buf); + if (!$len) { + break; + } + $remaining -= $len; + $dest->write($buf); + } + } + } + + /** + * Copy the contents of a stream into a string until the given number of + * bytes have been read. + * + * @param StreamInterface $stream Stream to read + * @param int $maxLen Maximum number of bytes to read. Pass -1 + * to read the entire stream. + * + * @throws \RuntimeException on error. + */ + public static function copyToString(StreamInterface $stream, int $maxLen = -1): string + { + $buffer = ''; + + if ($maxLen === -1) { + while (!$stream->eof()) { + $buf = $stream->read(1048576); + if ($buf === '') { + break; + } + $buffer .= $buf; + } + return $buffer; + } + + $len = 0; + while (!$stream->eof() && $len < $maxLen) { + $buf = $stream->read($maxLen - $len); + if ($buf === '') { + break; + } + $buffer .= $buf; + $len = strlen($buffer); + } + + return $buffer; + } + + /** + * Calculate a hash of a stream. + * + * This method reads the entire stream to calculate a rolling hash, based + * on PHP's `hash_init` functions. + * + * @param StreamInterface $stream Stream to calculate the hash for + * @param string $algo Hash algorithm (e.g. md5, crc32, etc) + * @param bool $rawOutput Whether or not to use raw output + * + * @throws \RuntimeException on error. + */ + public static function hash(StreamInterface $stream, string $algo, bool $rawOutput = false): string + { + $pos = $stream->tell(); + + if ($pos > 0) { + $stream->rewind(); + } + + $ctx = hash_init($algo); + while (!$stream->eof()) { + hash_update($ctx, $stream->read(1048576)); + } + + $out = hash_final($ctx, (bool) $rawOutput); + $stream->seek($pos); + + return $out; + } + + /** + * Clone and modify a request with the given changes. + * + * This method is useful for reducing the number of clones needed to mutate + * a message. + * + * The changes can be one of: + * - method: (string) Changes the HTTP method. + * - set_headers: (array) Sets the given headers. + * - remove_headers: (array) Remove the given headers. + * - body: (mixed) Sets the given body. + * - uri: (UriInterface) Set the URI. + * - query: (string) Set the query string value of the URI. + * - version: (string) Set the protocol version. + * + * @param RequestInterface $request Request to clone and modify. + * @param array $changes Changes to apply. + */ + public static function modifyRequest(RequestInterface $request, array $changes): RequestInterface + { + if (!$changes) { + return $request; + } + + $headers = $request->getHeaders(); + + if (!isset($changes['uri'])) { + $uri = $request->getUri(); + } else { + // Remove the host header if one is on the URI + if ($host = $changes['uri']->getHost()) { + $changes['set_headers']['Host'] = $host; + + if ($port = $changes['uri']->getPort()) { + $standardPorts = ['http' => 80, 'https' => 443]; + $scheme = $changes['uri']->getScheme(); + if (isset($standardPorts[$scheme]) && $port != $standardPorts[$scheme]) { + $changes['set_headers']['Host'] .= ':' . $port; + } + } + } + $uri = $changes['uri']; + } + + if (!empty($changes['remove_headers'])) { + $headers = self::caselessRemove($changes['remove_headers'], $headers); + } + + if (!empty($changes['set_headers'])) { + $headers = self::caselessRemove(array_keys($changes['set_headers']), $headers); + $headers = $changes['set_headers'] + $headers; + } + + if (isset($changes['query'])) { + $uri = $uri->withQuery($changes['query']); + } + + if ($request instanceof ServerRequestInterface) { + $new = (new ServerRequest( + $changes['method'] ?? $request->getMethod(), + $uri, + $headers, + $changes['body'] ?? $request->getBody(), + $changes['version'] ?? $request->getProtocolVersion(), + $request->getServerParams() + )) + ->withParsedBody($request->getParsedBody()) + ->withQueryParams($request->getQueryParams()) + ->withCookieParams($request->getCookieParams()) + ->withUploadedFiles($request->getUploadedFiles()); + + foreach ($request->getAttributes() as $key => $value) { + $new = $new->withAttribute($key, $value); + } + + return $new; + } + + return new Request( + $changes['method'] ?? $request->getMethod(), + $uri, + $headers, + $changes['body'] ?? $request->getBody(), + $changes['version'] ?? $request->getProtocolVersion() + ); + } + + /** + * Read a line from the stream up to the maximum allowed buffer length. + * + * @param StreamInterface $stream Stream to read from + * @param int|null $maxLength Maximum buffer length + */ + public static function readLine(StreamInterface $stream, ?int $maxLength = null): string + { + $buffer = ''; + $size = 0; + + while (!$stream->eof()) { + if ('' === ($byte = $stream->read(1))) { + return $buffer; + } + $buffer .= $byte; + // Break when a new line is found or the max length - 1 is reached + if ($byte === "\n" || ++$size === $maxLength - 1) { + break; + } + } + + return $buffer; + } + + /** + * Create a new stream based on the input type. + * + * Options is an associative array that can contain the following keys: + * - metadata: Array of custom metadata. + * - size: Size of the stream. + * + * This method accepts the following `$resource` types: + * - `Psr\Http\Message\StreamInterface`: Returns the value as-is. + * - `string`: Creates a stream object that uses the given string as the contents. + * - `resource`: Creates a stream object that wraps the given PHP stream resource. + * - `Iterator`: If the provided value implements `Iterator`, then a read-only + * stream object will be created that wraps the given iterable. Each time the + * stream is read from, data from the iterator will fill a buffer and will be + * continuously called until the buffer is equal to the requested read size. + * Subsequent read calls will first read from the buffer and then call `next` + * on the underlying iterator until it is exhausted. + * - `object` with `__toString()`: If the object has the `__toString()` method, + * the object will be cast to a string and then a stream will be returned that + * uses the string value. + * - `NULL`: When `null` is passed, an empty stream object is returned. + * - `callable` When a callable is passed, a read-only stream object will be + * created that invokes the given callable. The callable is invoked with the + * number of suggested bytes to read. The callable can return any number of + * bytes, but MUST return `false` when there is no more data to return. The + * stream object that wraps the callable will invoke the callable until the + * number of requested bytes are available. Any additional bytes will be + * buffered and used in subsequent reads. + * + * @param resource|string|int|float|bool|StreamInterface|callable|\Iterator|null $resource Entity body data + * @param array{size?: int, metadata?: array} $options Additional options + * + * @throws \InvalidArgumentException if the $resource arg is not valid. + */ + public static function streamFor($resource = '', array $options = []): StreamInterface + { + if (is_scalar($resource)) { + $stream = self::tryFopen('php://temp', 'r+'); + if ($resource !== '') { + fwrite($stream, (string) $resource); + fseek($stream, 0); + } + return new Stream($stream, $options); + } + + switch (gettype($resource)) { + case 'resource': + /* + * The 'php://input' is a special stream with quirks and inconsistencies. + * We avoid using that stream by reading it into php://temp + */ + + /** @var resource $resource */ + if ((\stream_get_meta_data($resource)['uri'] ?? '') === 'php://input') { + $stream = self::tryFopen('php://temp', 'w+'); + fwrite($stream, stream_get_contents($resource)); + fseek($stream, 0); + $resource = $stream; + } + return new Stream($resource, $options); + case 'object': + /** @var object $resource */ + if ($resource instanceof StreamInterface) { + return $resource; + } elseif ($resource instanceof \Iterator) { + return new PumpStream(function () use ($resource) { + if (!$resource->valid()) { + return false; + } + $result = $resource->current(); + $resource->next(); + return $result; + }, $options); + } elseif (method_exists($resource, '__toString')) { + return self::streamFor((string) $resource, $options); + } + break; + case 'NULL': + return new Stream(self::tryFopen('php://temp', 'r+'), $options); + } + + if (is_callable($resource)) { + return new PumpStream($resource, $options); + } + + throw new \InvalidArgumentException('Invalid resource type: ' . gettype($resource)); + } + + /** + * Safely opens a PHP stream resource using a filename. + * + * When fopen fails, PHP normally raises a warning. This function adds an + * error handler that checks for errors and throws an exception instead. + * + * @param string $filename File to open + * @param string $mode Mode used to open the file + * + * @return resource + * + * @throws \RuntimeException if the file cannot be opened + */ + public static function tryFopen(string $filename, string $mode) + { + $ex = null; + set_error_handler(static function (int $errno, string $errstr) use ($filename, $mode, &$ex): bool { + $ex = new \RuntimeException(sprintf( + 'Unable to open "%s" using mode "%s": %s', + $filename, + $mode, + $errstr + )); + + return true; + }); + + try { + /** @var resource $handle */ + $handle = fopen($filename, $mode); + } catch (\Throwable $e) { + $ex = new \RuntimeException(sprintf( + 'Unable to open "%s" using mode "%s": %s', + $filename, + $mode, + $e->getMessage() + ), 0, $e); + } + + restore_error_handler(); + + if ($ex) { + /** @var $ex \RuntimeException */ + throw $ex; + } + + return $handle; + } + + /** + * Returns a UriInterface for the given value. + * + * This function accepts a string or UriInterface and returns a + * UriInterface for the given value. If the value is already a + * UriInterface, it is returned as-is. + * + * @param string|UriInterface $uri + * + * @throws \InvalidArgumentException + */ + public static function uriFor($uri): UriInterface + { + if ($uri instanceof UriInterface) { + return $uri; + } + + if (is_string($uri)) { + return new Uri($uri); + } + + throw new \InvalidArgumentException('URI must be a string or UriInterface'); + } +} diff --git a/lib/guzzlehttp/psr7/vendor-bin/php-cs-fixer/composer.json b/lib/guzzlehttp/psr7/vendor-bin/php-cs-fixer/composer.json new file mode 100644 index 00000000..d69a683b --- /dev/null +++ b/lib/guzzlehttp/psr7/vendor-bin/php-cs-fixer/composer.json @@ -0,0 +1,9 @@ +{ + "require": { + "php": "^7.2.5 || ^8.0", + "friendsofphp/php-cs-fixer": "3.2.1" + }, + "config": { + "preferred-install": "dist" + } +} diff --git a/lib/guzzlehttp/psr7/vendor-bin/phpstan/composer.json b/lib/guzzlehttp/psr7/vendor-bin/phpstan/composer.json new file mode 100644 index 00000000..bfbc7273 --- /dev/null +++ b/lib/guzzlehttp/psr7/vendor-bin/phpstan/composer.json @@ -0,0 +1,10 @@ +{ + "require": { + "php": "^7.2.5 || ^8.0", + "phpstan/phpstan": "0.12.81", + "phpstan/phpstan-deprecation-rules": "0.12.6" + }, + "config": { + "preferred-install": "dist" + } +} diff --git a/lib/guzzlehttp/psr7/vendor-bin/psalm/composer.json b/lib/guzzlehttp/psr7/vendor-bin/psalm/composer.json new file mode 100644 index 00000000..535a0797 --- /dev/null +++ b/lib/guzzlehttp/psr7/vendor-bin/psalm/composer.json @@ -0,0 +1,9 @@ +{ + "require": { + "php": "^7.2.5 || ^8.0", + "psalm/phar": "4.6.2" + }, + "config": { + "preferred-install": "dist" + } +} diff --git a/lib/http_request.inc.php b/lib/http_request.inc.php index c533b5c8..04c79da4 100755 --- a/lib/http_request.inc.php +++ b/lib/http_request.inc.php @@ -146,7 +146,7 @@ public function send_http_request($url, $referer, $data, $method = 'POST', $cont // parse the given URL $url = parse_url($url); - if ($url['scheme'] != 'http') { + if (!in_array($url['scheme'], ['http', 'https'])) { return false; } diff --git a/lib/lang/locale/id_ID/LC_MESSAGES/messages.mo b/lib/lang/locale/id_ID/LC_MESSAGES/messages.mo index 39f5d6bf..fc3ff55a 100644 Binary files a/lib/lang/locale/id_ID/LC_MESSAGES/messages.mo and b/lib/lang/locale/id_ID/LC_MESSAGES/messages.mo differ diff --git a/lib/lang/locale/id_ID/LC_MESSAGES/messages.po b/lib/lang/locale/id_ID/LC_MESSAGES/messages.po index 06484e3c..aeebde01 100755 --- a/lib/lang/locale/id_ID/LC_MESSAGES/messages.po +++ b/lib/lang/locale/id_ID/LC_MESSAGES/messages.po @@ -5,8 +5,8 @@ msgid "" msgstr "" "Project-Id-Version: Senayan3\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2021-06-21 11:10+0700\n" -"PO-Revision-Date: 2021-06-21 11:15+0700\n" +"POT-Creation-Date: 2021-11-25 14:35+0700\n" +"PO-Revision-Date: 2021-11-25 14:38+0700\n" "Last-Translator: Arif Syamsudin Budi W. \n" "Language-Team: Arie Nugraha; Hendro Wicaksono; Wardiyono \n" @@ -86,7 +86,7 @@ msgstr "Tutup" #: admin/admin_template/default/index_template.inc.php:72 #: admin/admin_template/nightmode/index_template.inc.php:68 admin/chat.php:15 -#: lib/contents/chat.php:89 sysconfig.inc.php:712 +#: lib/contents/chat.php:89 sysconfig.inc.php:719 #: template/akasia-dz/partials/nav.php:10 template/akasia/partials/nav.php:10 #: template/default/parts/_navbar.php:27 template/default/parts/footer.php:41 #: template/lightweight/partials/nav.php:10 @@ -120,7 +120,7 @@ msgstr "Selalu Tunjukkan Jalur Gulung" #: admin/modules/bibliography/export.php:211 #: admin/modules/bibliography/import.php:288 #: admin/modules/bibliography/item_export.php:188 -#: admin/modules/bibliography/item_import.php:237 +#: admin/modules/bibliography/item_import.php:246 #: admin/modules/membership/export.php:168 #: admin/modules/membership/import.php:229 #: admin/modules/membership/index.php:557 @@ -282,7 +282,7 @@ msgstr "Total Eksemplar" msgid "Lent" msgstr "Dipinjamkan" -#: admin/default/home.php:186 admin/modules/bibliography/index.php:805 +#: admin/default/home.php:186 admin/modules/bibliography/index.php:813 #: admin/modules/bibliography/item.php:323 #: admin/modules/circulation/reserve_list.php:110 #: admin/modules/reporting/customs/item_titles_list.php:257 @@ -333,7 +333,7 @@ msgstr "Perpanjang" #: admin/default/home.php:240 admin/default/home.php:303 #: admin/modules/membership/member_base_lib.inc.php:208 -#: admin/modules/reporting/customs/overdued_list.php:196 +#: admin/modules/reporting/customs/overdued_list.php:209 msgid "Overdue" msgstr "Keterlambatan" @@ -350,7 +350,7 @@ msgstr "Keterlambatan" #: admin/modules/bibliography/iframe_topic.php:43 #: admin/modules/bibliography/import.php:46 #: admin/modules/bibliography/index.php:59 -#: admin/modules/bibliography/index.php:671 +#: admin/modules/bibliography/index.php:679 #: admin/modules/bibliography/item.php:54 #: admin/modules/bibliography/item.php:226 #: admin/modules/bibliography/item_barcode_generator.php:44 @@ -396,15 +396,15 @@ msgstr "Ubah Profil Pengguna" msgid "Change Current User Profiles and Password" msgstr "Ubah Profil dan Kata Sandi Pengguna Saat Ini" -#: admin/default/submenu.php:23 admin/modules/system/submenu.php:51 +#: admin/default/submenu.php:23 admin/modules/system/submenu.php:53 msgid "Shortcut Setting" msgstr "Pengaturan Pemintas" -#: admin/default/submenu.php:24 admin/modules/system/submenu.php:34 +#: admin/default/submenu.php:24 admin/modules/system/submenu.php:35 msgid "Theme" msgstr "Tema" -#: admin/default/submenu.php:24 admin/modules/system/submenu.php:34 +#: admin/default/submenu.php:24 admin/modules/system/submenu.php:35 msgid "Configure theme Preferences" msgstr "Konfigurasi Tema" @@ -445,8 +445,8 @@ msgstr "Daftar Eksemplar Keluar" #: admin/modules/bibliography/checkout_item.php:56 #: admin/modules/bibliography/dl_print.php:228 #: admin/modules/bibliography/dl_print.php:230 -#: admin/modules/bibliography/index.php:572 -#: admin/modules/bibliography/index.php:582 +#: admin/modules/bibliography/index.php:580 +#: admin/modules/bibliography/index.php:590 #: admin/modules/bibliography/item.php:212 #: admin/modules/bibliography/item.php:215 #: admin/modules/bibliography/item_barcode_generator.php:221 @@ -605,11 +605,11 @@ msgstr "ID Anggota" #: admin/modules/bibliography/checkout_item.php:73 #: admin/modules/bibliography/dl_print.php:263 #: admin/modules/bibliography/dl_print.php:271 -#: admin/modules/bibliography/index.php:733 -#: admin/modules/bibliography/index.php:1208 -#: admin/modules/bibliography/index.php:1215 -#: admin/modules/bibliography/index.php:1235 -#: admin/modules/bibliography/index.php:1241 +#: admin/modules/bibliography/index.php:741 +#: admin/modules/bibliography/index.php:1216 +#: admin/modules/bibliography/index.php:1223 +#: admin/modules/bibliography/index.php:1243 +#: admin/modules/bibliography/index.php:1249 #: admin/modules/bibliography/item.php:287 #: admin/modules/bibliography/item.php:406 #: admin/modules/bibliography/item.php:415 @@ -622,7 +622,7 @@ msgstr "ID Anggota" #: admin/modules/bibliography/marcsru.php:343 #: admin/modules/bibliography/p2p.php:313 #: admin/modules/bibliography/p2p.php:369 -#: admin/modules/bibliography/pop_attach.php:204 +#: admin/modules/bibliography/pop_attach.php:211 #: admin/modules/bibliography/pop_author_edit.php:89 #: admin/modules/bibliography/pop_biblio_rel.php:90 #: admin/modules/bibliography/pop_biblio_rel.php:92 @@ -680,7 +680,7 @@ msgstr "Judul" #: admin/modules/reporting/customs/loan_history.php:153 #: admin/modules/reporting/customs/loan_history.php:238 #: admin/modules/reporting/customs/member_loan_list.php:191 -#: admin/modules/reporting/customs/overdued_list.php:197 +#: admin/modules/reporting/customs/overdued_list.php:210 #: lib/contents/download_current_loan.inc.php:63 #: lib/contents/download_loan_history.inc.php:63 #: lib/contents/member.inc.php:361 lib/contents/member.inc.php:407 @@ -696,7 +696,7 @@ msgstr "Tanggal Pinjam" #: admin/modules/reporting/customs/loan_history.php:154 #: admin/modules/reporting/customs/loan_history.php:239 #: admin/modules/reporting/customs/member_loan_list.php:191 -#: admin/modules/reporting/customs/overdued_list.php:197 +#: admin/modules/reporting/customs/overdued_list.php:210 #: lib/contents/download_current_loan.inc.php:64 #: lib/contents/member.inc.php:362 msgid "Due Date" @@ -704,7 +704,7 @@ msgstr "Tanggal Kembali" #: admin/modules/bibliography/checkout_item.php:116 #: admin/modules/bibliography/dl_print.php:309 -#: admin/modules/bibliography/index.php:1301 +#: admin/modules/bibliography/index.php:1309 #: admin/modules/bibliography/item.php:502 #: admin/modules/bibliography/item_barcode_generator.php:300 #: admin/modules/bibliography/marcexport.php:265 @@ -733,10 +733,10 @@ msgstr "Tanggal Kembali" #: admin/modules/stock_take/current.php:194 #: admin/modules/stock_take/index.php:170 #: admin/modules/stock_take/st_log.php:112 -#: admin/modules/system/app_user.php:469 admin/modules/system/backup.php:193 +#: admin/modules/system/app_user.php:469 admin/modules/system/backup.php:185 #: admin/modules/system/content.php:298 #: admin/modules/system/custom_field.php:291 -#: admin/modules/system/holiday.php:267 admin/modules/system/module.php:226 +#: admin/modules/system/holiday.php:297 admin/modules/system/module.php:226 #: admin/modules/system/sys_log.php:142 admin/modules/system/user_group.php:276 #: plugins/label_barcode/index.php:379 msgid "Found {result->num_rows} from your keywords" @@ -850,7 +850,7 @@ msgstr "dalam antrian menunggu untuk dicetak." #: admin/modules/bibliography/dl_print.php:264 #: admin/modules/bibliography/dl_print.php:272 -#: admin/modules/bibliography/index.php:932 +#: admin/modules/bibliography/index.php:940 #: admin/modules/bibliography/item.php:299 #: admin/modules/bibliography/item.php:451 #: admin/modules/bibliography/item.php:463 @@ -902,22 +902,22 @@ msgid "Add to print queue?" msgstr "Tambahkan dalam antrian cetak?" #: admin/modules/bibliography/dl_print.php:310 -#: admin/modules/bibliography/index.php:1302 +#: admin/modules/bibliography/index.php:1310 #: admin/modules/bibliography/item.php:503 #: admin/modules/bibliography/item_barcode_generator.php:301 #: admin/modules/bibliography/marcexport.php:266 #: admin/modules/bibliography/printed_card.php:403 -#: lib/contents/default.inc.php:209 plugins/label_barcode/index.php:380 +#: lib/contents/default.inc.php:218 plugins/label_barcode/index.php:380 msgid "Query took" msgstr "Permintaan membutuhkan" #: admin/modules/bibliography/dl_print.php:310 -#: admin/modules/bibliography/index.php:1302 +#: admin/modules/bibliography/index.php:1310 #: admin/modules/bibliography/item.php:503 #: admin/modules/bibliography/item_barcode_generator.php:301 #: admin/modules/bibliography/marcexport.php:266 #: admin/modules/bibliography/printed_card.php:403 -#: lib/contents/default.inc.php:209 plugins/label_barcode/index.php:380 +#: lib/contents/default.inc.php:218 plugins/label_barcode/index.php:380 msgid "second(s) to complete" msgstr "detik untuk selesai" @@ -959,7 +959,7 @@ msgstr "Ekspor Sekarang" #: admin/modules/bibliography/export.php:199 #: admin/modules/bibliography/import.php:280 #: admin/modules/bibliography/item_export.php:176 -#: admin/modules/bibliography/item_import.php:229 +#: admin/modules/bibliography/item_import.php:238 #: admin/modules/membership/export.php:156 #: admin/modules/membership/import.php:221 msgid "Field Separator" @@ -968,7 +968,7 @@ msgstr "Pemisah Ruas" #: admin/modules/bibliography/export.php:201 #: admin/modules/bibliography/import.php:282 #: admin/modules/bibliography/item_export.php:178 -#: admin/modules/bibliography/item_import.php:231 +#: admin/modules/bibliography/item_import.php:240 #: admin/modules/membership/export.php:158 #: admin/modules/membership/import.php:223 msgid "Field Enclosed With" @@ -991,7 +991,7 @@ msgstr "Jumlah Cantuman untuk diekspor (0 untuk semua rekod)" #: admin/modules/bibliography/export.php:209 #: admin/modules/bibliography/import.php:286 #: admin/modules/bibliography/item_export.php:186 -#: admin/modules/bibliography/item_import.php:235 +#: admin/modules/bibliography/item_import.php:244 #: admin/modules/bibliography/marcexport.php:201 #: admin/modules/membership/export.php:166 #: admin/modules/membership/import.php:227 @@ -1029,7 +1029,7 @@ msgid "Delete" msgstr "Hapus" #: admin/modules/bibliography/iframe_attach.php:127 -#: admin/modules/bibliography/index.php:1015 +#: admin/modules/bibliography/index.php:1023 msgid "File Attachments" msgstr "Lampiran Berkas" @@ -1141,7 +1141,7 @@ msgid "Item FAILED to removed!" msgstr "Eksemplar GAGAL hapus!" #: admin/modules/bibliography/iframe_item_list.php:123 -#: admin/modules/bibliography/index.php:857 +#: admin/modules/bibliography/index.php:865 msgid "Items/Copies" msgstr "Eksemplar/Kopi" @@ -1209,35 +1209,35 @@ msgstr "" #: admin/modules/bibliography/import.php:249 msgid "" -"Import for bibliographics data from CSV file. For guide on CVS fields order " +"Import for bibliographics data from CSV file. For guide on CSV fields order " "and format please refer to documentation or visit Official Website" msgstr "" -"Impor data bibiliografi dari berkas CSV. Lihat panduan tentang format " -"penulisan dan urutan ruas dalam berkas CSV atau kunjungi Situs Resmi SLiMS" +"Berkas CSV untuk impor data bibliografi. Lihat panduan tentang urutan ruas " +"dalam berkas CSV atau kunjungi Situs Resmi SLiMS" #: admin/modules/bibliography/import.php:258 -#: admin/modules/bibliography/item_import.php:208 +#: admin/modules/bibliography/item_import.php:217 #: admin/modules/bibliography/marcimport.php:403 #: admin/modules/membership/import.php:199 msgid "Import Now" msgstr "Impor Sekarang" #: admin/modules/bibliography/import.php:278 -#: admin/modules/bibliography/item_import.php:227 +#: admin/modules/bibliography/item_import.php:236 #: admin/modules/bibliography/marcimport.php:422 #: admin/modules/membership/import.php:219 msgid "File To Import" msgstr "Berkas untuk di impor" #: admin/modules/bibliography/import.php:284 -#: admin/modules/bibliography/item_import.php:233 +#: admin/modules/bibliography/item_import.php:242 msgid "Number of Records To Import (0 for all records)" msgstr "Jumlah cantuman untuk di impor (0 untuk semua rekod)" #: admin/modules/bibliography/import.php:288 -#: admin/modules/bibliography/item_import.php:237 +#: admin/modules/bibliography/item_import.php:246 msgid "The first row is the columns names" msgstr "Baris pertama adalah nama kolom" @@ -1247,7 +1247,7 @@ msgid "{imageFilename} successfully removed!" msgstr "{imageFilename} berhasil hapus!" #: admin/modules/bibliography/index.php:109 -#: admin/modules/bibliography/index.php:457 +#: admin/modules/bibliography/index.php:465 #: admin/modules/system/app_user.php:102 msgid "Invalid form submission token!" msgstr "Invalid form submission token!" @@ -1268,41 +1268,41 @@ msgstr "Ruas %s hanya menggunakan angka" msgid "Field %s is date format, empty not allowed" msgstr "Ruas %s adalah tanggal, tidak boleh kosong" -#: admin/modules/bibliography/index.php:235 +#: admin/modules/bibliography/index.php:242 #: admin/modules/membership/index.php:253 #: admin/modules/membership/index.php:290 admin/modules/system/app_user.php:182 #: admin/modules/system/app_user.php:205 msgid "Image Uploaded Successfully" msgstr "Gambar Berhasil Diunggah" -#: admin/modules/bibliography/index.php:239 +#: admin/modules/bibliography/index.php:247 msgid "Image Uploaded Failed" msgstr "Unggah Gambar Gagal" -#: admin/modules/bibliography/index.php:292 +#: admin/modules/bibliography/index.php:300 msgid "Bibliography Data Successfully Updated" msgstr "Data bibliografi berhasil diperbaharui" -#: admin/modules/bibliography/index.php:322 +#: admin/modules/bibliography/index.php:330 msgid "" "Bibliography Data FAILED to Updated. Please Contact System Administrator" msgstr "Data bibliografi GAGAL diperbaharui. Hubungi Administrator Sistem" -#: admin/modules/bibliography/index.php:371 +#: admin/modules/bibliography/index.php:379 msgid "New Bibliography Data Successfully Saved" msgstr "Data baru bibliografi berhasil disimpan" -#: admin/modules/bibliography/index.php:394 +#: admin/modules/bibliography/index.php:402 msgid "Bibliography Data FAILED to Save. Please Contact System Administrator" msgstr "Data bibliografi GAGAL disimpan. Hubungi Administrator Sistem" -#: admin/modules/bibliography/index.php:405 +#: admin/modules/bibliography/index.php:413 #, php-format msgid "Item Data FAILED to Save. Insert batch item maximum %s copies" msgstr "" "Data Eksemplar GAGAL disimpan. Jumlah eksemplar massal maksimum %s salinan" -#: admin/modules/bibliography/index.php:536 +#: admin/modules/bibliography/index.php:544 #: admin/modules/master_file/author.php:166 #: admin/modules/master_file/coll_type.php:125 #: admin/modules/master_file/doc_language.php:130 @@ -1319,7 +1319,7 @@ msgstr "" msgid "Below data can not be deleted:" msgstr "Data berikut tidak bisa dihapus :" -#: admin/modules/bibliography/index.php:546 +#: admin/modules/bibliography/index.php:554 #: admin/modules/circulation/loan_rules.php:117 #: admin/modules/master_file/author.php:174 #: admin/modules/master_file/coll_type.php:130 @@ -1346,7 +1346,7 @@ msgstr "Data berikut tidak bisa dihapus :" msgid "All Data Successfully Deleted" msgstr "Semua Data Berhasil Dihapus" -#: admin/modules/bibliography/index.php:549 +#: admin/modules/bibliography/index.php:557 #: admin/modules/circulation/loan_rules.php:124 #: admin/modules/master_file/author.php:178 #: admin/modules/master_file/coll_type.php:133 @@ -1375,37 +1375,37 @@ msgid "" "administrator" msgstr "Sebagian atau semua data GAGAL dihapus!\\nHubungi administrator sistem" -#: admin/modules/bibliography/index.php:562 +#: admin/modules/bibliography/index.php:570 msgid "Bibliographic" msgstr "Bibliografi" -#: admin/modules/bibliography/index.php:567 +#: admin/modules/bibliography/index.php:575 #: admin/modules/bibliography/submenu.php:28 msgid "Bibliographic List" msgstr "Daftar Bibliografi" -#: admin/modules/bibliography/index.php:569 +#: admin/modules/bibliography/index.php:577 #: admin/modules/bibliography/submenu.php:29 msgid "Add New Bibliography" msgstr "Tambah Bibliografi Baru" -#: admin/modules/bibliography/index.php:575 +#: admin/modules/bibliography/index.php:583 msgid "All Fields" msgstr "Semua Ruas" -#: admin/modules/bibliography/index.php:576 +#: admin/modules/bibliography/index.php:584 #: admin/modules/bibliography/marcsru.php:443 #: admin/modules/bibliography/z3950.php:293 #: admin/modules/bibliography/z3950sru.php:321 msgid "Title/Series Title" msgstr "Judul/Judul Seri" -#: admin/modules/bibliography/index.php:577 +#: admin/modules/bibliography/index.php:585 #: admin/modules/bibliography/pop_p2p.php:70 msgid "Topics" msgstr "Topik" -#: admin/modules/bibliography/index.php:578 +#: admin/modules/bibliography/index.php:586 #: admin/modules/bibliography/marcsru.php:444 #: admin/modules/bibliography/pop_p2p.php:54 #: admin/modules/bibliography/z3950.php:293 @@ -1413,12 +1413,12 @@ msgstr "Topik" msgid "Authors" msgstr "Pengarang" -#: admin/modules/bibliography/index.php:579 -#: admin/modules/bibliography/index.php:900 -#: admin/modules/bibliography/index.php:1210 -#: admin/modules/bibliography/index.php:1216 -#: admin/modules/bibliography/index.php:1236 -#: admin/modules/bibliography/index.php:1242 +#: admin/modules/bibliography/index.php:587 +#: admin/modules/bibliography/index.php:908 +#: admin/modules/bibliography/index.php:1218 +#: admin/modules/bibliography/index.php:1224 +#: admin/modules/bibliography/index.php:1244 +#: admin/modules/bibliography/index.php:1250 #: admin/modules/bibliography/marcsru.php:343 #: admin/modules/bibliography/marcsru.php:442 #: admin/modules/bibliography/pop_p2p.php:57 @@ -1445,8 +1445,8 @@ msgstr "Pengarang" msgid "ISBN/ISSN" msgstr "ISBN/ISSN" -#: admin/modules/bibliography/index.php:580 -#: admin/modules/bibliography/index.php:909 +#: admin/modules/bibliography/index.php:588 +#: admin/modules/bibliography/index.php:917 #: admin/modules/bibliography/pop_p2p.php:58 #: admin/modules/bibliography/z3950sru.php:214 #: admin/modules/master_file/publisher.php:57 @@ -1469,17 +1469,17 @@ msgstr "ISBN/ISSN" msgid "Publisher" msgstr "Penerbit" -#: admin/modules/bibliography/index.php:585 +#: admin/modules/bibliography/index.php:593 msgid "Advanced Filter" msgstr "Pencarian Spesifik" -#: admin/modules/bibliography/index.php:588 -#: admin/modules/bibliography/index.php:1066 +#: admin/modules/bibliography/index.php:596 +#: admin/modules/bibliography/index.php:1074 msgid "Hide in OPAC" msgstr "Sembunyikan di OPAC" -#: admin/modules/bibliography/index.php:590 -#: admin/modules/bibliography/index.php:596 +#: admin/modules/bibliography/index.php:598 +#: admin/modules/bibliography/index.php:604 #: admin/modules/bibliography/p2p.php:312 #: admin/modules/circulation/loan_rules.php:201 #: admin/modules/circulation/loan_rules.php:206 @@ -1517,8 +1517,8 @@ msgstr "Sembunyikan di OPAC" msgid "ALL" msgstr "SEMUA" -#: admin/modules/bibliography/index.php:591 -#: admin/modules/bibliography/index.php:1064 +#: admin/modules/bibliography/index.php:599 +#: admin/modules/bibliography/index.php:1072 #: admin/modules/bibliography/print_settings.php:92 #: admin/modules/system/custom_field.php:232 template/default/tinfo.inc.php:52 #: template/default/tinfo.inc.php:103 template/default/tinfo.inc.php:119 @@ -1527,8 +1527,8 @@ msgstr "SEMUA" msgid "Show" msgstr "Tunjukan" -#: admin/modules/bibliography/index.php:592 -#: admin/modules/bibliography/index.php:1065 +#: admin/modules/bibliography/index.php:600 +#: admin/modules/bibliography/index.php:1073 #: admin/modules/bibliography/print_settings.php:91 #: admin/modules/system/custom_field.php:231 template/default/tinfo.inc.php:53 #: template/default/tinfo.inc.php:104 template/default/tinfo.inc.php:120 @@ -1537,26 +1537,26 @@ msgstr "Tunjukan" msgid "Hide" msgstr "Sembunyikan" -#: admin/modules/bibliography/index.php:594 -#: admin/modules/bibliography/index.php:1070 +#: admin/modules/bibliography/index.php:602 +#: admin/modules/bibliography/index.php:1078 msgid "Promote To Homepage" msgstr "Promosikan Ke Beranda" -#: admin/modules/bibliography/index.php:597 -#: admin/modules/bibliography/index.php:1068 +#: admin/modules/bibliography/index.php:605 +#: admin/modules/bibliography/index.php:1076 msgid "Don't Promote" msgstr "Jangan Promosikan" -#: admin/modules/bibliography/index.php:598 -#: admin/modules/bibliography/index.php:1069 +#: admin/modules/bibliography/index.php:606 +#: admin/modules/bibliography/index.php:1077 msgid "Promote" msgstr "Promosikan" -#: admin/modules/bibliography/index.php:607 +#: admin/modules/bibliography/index.php:615 msgid "Upload Selected Bibliographic data to Union Catalog Server*" msgstr "Unggah Data Bibliografi Terpilih ke Peladen Katalog Induk" -#: admin/modules/bibliography/index.php:626 +#: admin/modules/bibliography/index.php:634 #: admin/modules/reporting/customs/dl_detail.php:120 #: admin/modules/reporting/customs/dl_detail.php:182 #: admin/modules/system/custom_field.php:228 @@ -1564,19 +1564,19 @@ msgstr "Unggah Data Bibliografi Terpilih ke Peladen Katalog Induk" msgid "Date" msgstr "Date" -#: admin/modules/bibliography/index.php:627 +#: admin/modules/bibliography/index.php:635 msgid "User Name" msgstr "Nama Pengguna" -#: admin/modules/bibliography/index.php:628 +#: admin/modules/bibliography/index.php:636 msgid "Additional Information" msgstr "Informasi Tambahan" -#: admin/modules/bibliography/index.php:657 +#: admin/modules/bibliography/index.php:665 msgid "Biblio Log" msgstr "Catatan Biblio" -#: admin/modules/bibliography/index.php:685 +#: admin/modules/bibliography/index.php:693 #: admin/modules/bibliography/item.php:240 #: admin/modules/bibliography/pop_pattern.php:102 #: admin/modules/circulation/fines_list.php:152 @@ -1609,11 +1609,11 @@ msgstr "Catatan Biblio" msgid "Save" msgstr "Simpan" -#: admin/modules/bibliography/index.php:693 +#: admin/modules/bibliography/index.php:701 msgid "Log" msgstr "Catatan" -#: admin/modules/bibliography/index.php:714 +#: admin/modules/bibliography/index.php:722 #: admin/modules/bibliography/item.php:259 #: admin/modules/bibliography/pop_author_edit.php:78 #: admin/modules/circulation/fines_list.php:171 @@ -1645,7 +1645,7 @@ msgstr "Catatan" msgid "Update" msgstr "Perbaharui" -#: admin/modules/bibliography/index.php:734 +#: admin/modules/bibliography/index.php:742 msgid "" "Main title of collection. Separate child title with colon and pararel title " "with equal (=) sign." @@ -1653,15 +1653,15 @@ msgstr "" "Judul utama koleksi. Pisahkan anak judul dengan titik dua (:) dan judul " "paralel dengan tanda sama dengan (=)." -#: admin/modules/bibliography/index.php:738 +#: admin/modules/bibliography/index.php:746 msgid "Authors/Roles" msgstr "Pengarang/Peran" -#: admin/modules/bibliography/index.php:738 +#: admin/modules/bibliography/index.php:746 msgid "Add Author(s)" msgstr "Tambah Data Pengarang" -#: admin/modules/bibliography/index.php:740 +#: admin/modules/bibliography/index.php:748 #: admin/modules/reporting/customs/dl_detail.php:81 #: admin/modules/serial_control/index.php:69 #: lib/contents/clustering.inc.php:120 @@ -1671,7 +1671,7 @@ msgstr "Tambah Data Pengarang" msgid "Author(s)" msgstr "Pengarang" -#: admin/modules/bibliography/index.php:744 +#: admin/modules/bibliography/index.php:752 #: template/akasia-dz/detail_template.php:150 #: template/akasia/detail_template.php:150 #: template/default/detail_template.php:100 @@ -1679,7 +1679,7 @@ msgstr "Pengarang" msgid "Statement of Responsibility" msgstr "Pernyataan Tanggungjawab" -#: admin/modules/bibliography/index.php:744 +#: admin/modules/bibliography/index.php:752 msgid "" "Main source of information to show who has written, composed, illustrated, " "or in other ways contributed to the existence of the item." @@ -1687,7 +1687,7 @@ msgstr "" "Sumber utama informasi untuk memperlihatkan siapa yang menulis, menyusun, " "membuat ilustrasi, atau berkontribusi dengan cara apapun." -#: admin/modules/bibliography/index.php:748 +#: admin/modules/bibliography/index.php:756 #: admin/modules/bibliography/pop_p2p.php:56 lib/detail.inc.php:268 #: template/akasia-dz/custom_frontpage_record.inc.php:6 #: template/akasia-dz/detail_template.php:129 @@ -1700,11 +1700,11 @@ msgstr "" msgid "Edition" msgstr "Edisi" -#: admin/modules/bibliography/index.php:748 +#: admin/modules/bibliography/index.php:756 msgid "A version of publication having substantial changes or additions." msgstr "Versi publikasi yang memiliki perubahan atau penambahan vital." -#: admin/modules/bibliography/index.php:750 +#: admin/modules/bibliography/index.php:758 #: template/akasia-dz/detail_template.php:143 #: template/akasia/detail_template.php:143 #: template/default/detail_template.php:96 @@ -1712,7 +1712,7 @@ msgstr "Versi publikasi yang memiliki perubahan atau penambahan vital." msgid "Specific Detail Info" msgstr "Info Detail Spesifik" -#: admin/modules/bibliography/index.php:750 +#: admin/modules/bibliography/index.php:758 msgid "" "explain more details about an item e.g. scale within a map, running time in " "a movie dvd." @@ -1720,31 +1720,31 @@ msgstr "" "menjelaskan detail lebih mendalam tentang suatu eksemplar, misal skala peta, " "waktu putar DVD." -#: admin/modules/bibliography/index.php:760 +#: admin/modules/bibliography/index.php:768 msgid "Choose pattern" msgstr "Pilih pola" -#: admin/modules/bibliography/index.php:775 +#: admin/modules/bibliography/index.php:783 msgid "Total item(s)" msgstr "Total item" -#: admin/modules/bibliography/index.php:777 +#: admin/modules/bibliography/index.php:785 #: admin/modules/reporting/customs/procurement_report.php:67 msgid "Options" msgstr "Pilihan" -#: admin/modules/bibliography/index.php:778 +#: admin/modules/bibliography/index.php:786 #: admin/modules/master_file/item_code_pattern.php:87 msgid "Add new pattern" msgstr "Tambah pola baru" -#: admin/modules/bibliography/index.php:778 +#: admin/modules/bibliography/index.php:786 #: admin/modules/bibliography/pop_pattern.php:125 msgid "Add New Pattern" msgstr "Tambah Pola Baru" -#: admin/modules/bibliography/index.php:783 -#: admin/modules/bibliography/index.php:787 +#: admin/modules/bibliography/index.php:791 +#: admin/modules/bibliography/index.php:795 #: admin/modules/bibliography/item.php:309 #: admin/modules/bibliography/item.php:408 #: admin/modules/bibliography/item.php:417 @@ -1773,14 +1773,14 @@ msgstr "Tambah Pola Baru" msgid "Location" msgstr "Lokasi" -#: admin/modules/bibliography/index.php:791 +#: admin/modules/bibliography/index.php:799 #: admin/modules/bibliography/item.php:311 #: admin/modules/stock_take/init.php:211 msgid "Shelf Location" msgstr "Lokasi Rak" -#: admin/modules/bibliography/index.php:796 -#: admin/modules/bibliography/index.php:800 +#: admin/modules/bibliography/index.php:804 +#: admin/modules/bibliography/index.php:808 #: admin/modules/bibliography/item.php:319 #: admin/modules/bibliography/item.php:407 #: admin/modules/bibliography/item.php:416 @@ -1822,7 +1822,7 @@ msgstr "Lokasi Rak" msgid "Collection Type" msgstr "Tipe Koleksi" -#: admin/modules/bibliography/index.php:809 +#: admin/modules/bibliography/index.php:817 #: admin/modules/bibliography/item.php:327 #: admin/modules/master_file/item_status.php:61 #: admin/modules/master_file/item_status.php:99 @@ -1840,53 +1840,53 @@ msgstr "Tipe Koleksi" msgid "Item Status" msgstr "Status Eksemplar" -#: admin/modules/bibliography/index.php:813 +#: admin/modules/bibliography/index.php:821 #: admin/modules/bibliography/item.php:343 msgid "Buy" msgstr "Beli" -#: admin/modules/bibliography/index.php:814 +#: admin/modules/bibliography/index.php:822 #: admin/modules/bibliography/item.php:344 msgid "Prize/Grant" msgstr "Hadiah/Hibah" -#: admin/modules/bibliography/index.php:815 +#: admin/modules/bibliography/index.php:823 #: admin/modules/bibliography/item.php:345 msgid "Source" msgstr "Sumber Perolehan" -#: admin/modules/bibliography/index.php:819 +#: admin/modules/bibliography/index.php:827 #: admin/modules/bibliography/item.php:331 msgid "Order Date" msgstr "Tanggal Pemesanan" -#: admin/modules/bibliography/index.php:823 +#: admin/modules/bibliography/index.php:831 #: admin/modules/bibliography/item.php:333 msgid "Receiving Date" msgstr "Tanggal Penerimaan" -#: admin/modules/bibliography/index.php:827 +#: admin/modules/bibliography/index.php:835 #: admin/modules/bibliography/item.php:329 msgid "Order Number" msgstr "No. Pemesanan" -#: admin/modules/bibliography/index.php:831 +#: admin/modules/bibliography/index.php:839 #: admin/modules/bibliography/item.php:347 msgid "Invoice" msgstr "Faktur" -#: admin/modules/bibliography/index.php:835 +#: admin/modules/bibliography/index.php:843 #: admin/modules/bibliography/item.php:349 msgid "Invoice Date" msgstr "Tanggal Faktur" -#: admin/modules/bibliography/index.php:840 -#: admin/modules/bibliography/index.php:890 +#: admin/modules/bibliography/index.php:848 +#: admin/modules/bibliography/index.php:898 #: admin/modules/bibliography/item.php:337 msgid "Not Applicable" msgstr "Tidak Digunakan" -#: admin/modules/bibliography/index.php:844 +#: admin/modules/bibliography/index.php:852 #: admin/modules/bibliography/item.php:341 #: admin/modules/master_file/submenu.php:32 #: admin/modules/master_file/supplier.php:56 @@ -1900,25 +1900,25 @@ msgstr "Tidak Digunakan" msgid "Supplier" msgstr "Agen" -#: admin/modules/bibliography/index.php:848 +#: admin/modules/bibliography/index.php:856 #: admin/modules/bibliography/item.php:357 #: admin/modules/reporting/customs/pop_procurement_list.php:168 msgid "Price" msgstr "Harga" -#: admin/modules/bibliography/index.php:853 +#: admin/modules/bibliography/index.php:861 msgid "Item(s) code batch generator" msgstr "Pembuat nomor eksemplar" -#: admin/modules/bibliography/index.php:857 +#: admin/modules/bibliography/index.php:865 msgid "Add New Items" msgstr "Tambah Eksemplar Baru" -#: admin/modules/bibliography/index.php:859 +#: admin/modules/bibliography/index.php:867 msgid "Item(s) Data" msgstr "Data Koleksi" -#: admin/modules/bibliography/index.php:868 +#: admin/modules/bibliography/index.php:876 #: admin/modules/bibliography/marcsru.php:343 #: admin/modules/bibliography/pop_p2p.php:61 #: admin/modules/bibliography/z3950sru.php:214 @@ -1941,25 +1941,25 @@ msgstr "Data Koleksi" msgid "GMD" msgstr "GMD" -#: admin/modules/bibliography/index.php:868 +#: admin/modules/bibliography/index.php:876 msgid "General material designation. The physical form of publication." msgstr "Tujuan utama bentuk. Bentuk fisik suatu publikasi." -#: admin/modules/bibliography/index.php:875 +#: admin/modules/bibliography/index.php:883 msgid "Not set" msgstr "Belum ditentukan" -#: admin/modules/bibliography/index.php:880 -#: admin/modules/bibliography/index.php:882 +#: admin/modules/bibliography/index.php:888 +#: admin/modules/bibliography/index.php:890 #: admin/modules/master_file/rda_cmc.php:139 msgid "RDA " msgstr "RDA " -#: admin/modules/bibliography/index.php:896 +#: admin/modules/bibliography/index.php:904 msgid "Use this for Serial publication" msgstr "Gunakan untuk koleksi terbitan berseri" -#: admin/modules/bibliography/index.php:898 +#: admin/modules/bibliography/index.php:906 #: admin/modules/master_file/frequency.php:55 #: admin/modules/master_file/frequency.php:76 #: admin/modules/master_file/frequency.php:78 @@ -1976,28 +1976,28 @@ msgstr "Gunakan untuk koleksi terbitan berseri" msgid "Frequency" msgstr "Kala Terbit" -#: admin/modules/bibliography/index.php:900 +#: admin/modules/bibliography/index.php:908 msgid "Unique publishing number for each title of publication." msgstr "Nomor publikasi yang unik dari setiap judul cetakan." -#: admin/modules/bibliography/index.php:911 +#: admin/modules/bibliography/index.php:919 #: admin/modules/bibliography/z3950sru.php:214 #: admin/modules/reporting/customs/pop_procurement_list.php:161 msgid "Publishing Year" msgstr "Tahun Terbit" -#: admin/modules/bibliography/index.php:911 +#: admin/modules/bibliography/index.php:919 msgid "Year of publication" msgstr "Tahun Terbit" -#: admin/modules/bibliography/index.php:920 +#: admin/modules/bibliography/index.php:928 #: admin/modules/reporting/customs/pop_procurement_list.php:162 #: admin/modules/reporting/customs/titles_list.php:129 #: admin/modules/reporting/customs/titles_list.php:257 msgid "Publishing Place" msgstr "Tempat Terbit" -#: admin/modules/bibliography/index.php:922 +#: admin/modules/bibliography/index.php:930 #: admin/modules/bibliography/pop_p2p.php:59 #: admin/modules/bibliography/z3950sru.php:214 #: template/akasia-dz/custom_frontpage_record.inc.php:8 @@ -2011,13 +2011,13 @@ msgstr "Tempat Terbit" msgid "Collation" msgstr "Deskripsi Fisik" -#: admin/modules/bibliography/index.php:922 +#: admin/modules/bibliography/index.php:930 msgid "" "Physical description of a publication e.g. publication length, width, page " "numbers, etc." msgstr "Deskripsi fisik publikasi, seperti lebar, tinggi, jumlah halaman, dll." -#: admin/modules/bibliography/index.php:924 +#: admin/modules/bibliography/index.php:932 #: template/akasia-dz/custom_frontpage_record.inc.php:9 #: template/akasia-dz/detail_template.php:50 #: template/akasia/custom_frontpage_record.inc.php:9 @@ -2029,7 +2029,7 @@ msgstr "Deskripsi fisik publikasi, seperti lebar, tinggi, jumlah halaman, dll." msgid "Series Title" msgstr "Judul Seri" -#: admin/modules/bibliography/index.php:930 +#: admin/modules/bibliography/index.php:938 #: admin/modules/bibliography/item.php:409 #: admin/modules/bibliography/item.php:418 #: admin/modules/bibliography/pop_p2p.php:62 @@ -2059,19 +2059,19 @@ msgstr "Judul Seri" msgid "Classification" msgstr "Klasifikasi" -#: admin/modules/bibliography/index.php:932 +#: admin/modules/bibliography/index.php:940 msgid "Sets of ID that put in the book spine." msgstr "Kumpulan identitas yang ditempel pada punggung buku." -#: admin/modules/bibliography/index.php:935 +#: admin/modules/bibliography/index.php:943 msgid "Subjects/Topics" msgstr "Subjek/Topik" -#: admin/modules/bibliography/index.php:935 +#: admin/modules/bibliography/index.php:943 msgid "Add Subject(s)" msgstr "Tambah Subjek" -#: admin/modules/bibliography/index.php:937 +#: admin/modules/bibliography/index.php:945 #: admin/modules/serial_control/index.php:68 lib/contents/clustering.inc.php:98 #: template/akasia-dz/detail_template.php:136 #: template/akasia/detail_template.php:136 @@ -2083,7 +2083,7 @@ msgstr "Tambah Subjek" msgid "Subject(s)" msgstr "Subjek" -#: admin/modules/bibliography/index.php:945 +#: admin/modules/bibliography/index.php:953 #: admin/modules/bibliography/pop_p2p.php:60 #: admin/modules/master_file/doc_language.php:202 #: admin/modules/master_file/doc_language.php:218 @@ -2103,163 +2103,163 @@ msgstr "Subjek" msgid "Language" msgstr "Bahasa" -#: admin/modules/bibliography/index.php:945 +#: admin/modules/bibliography/index.php:953 msgid "Language use by publication." msgstr "Bahasa publikasi." -#: admin/modules/bibliography/index.php:947 +#: admin/modules/bibliography/index.php:955 msgid "Abstract/Notes" msgstr "Abstrak/Catatan" -#: admin/modules/bibliography/index.php:947 +#: admin/modules/bibliography/index.php:955 msgid "Insert here any abstract or notes from the publication." msgstr "Masukkan catatan atau abstrak publikasi, di sini." -#: admin/modules/bibliography/index.php:957 +#: admin/modules/bibliography/index.php:965 #: admin/modules/membership/index.php:564 msgid "Click to enlarge preview" msgstr "Klik untuk memperbesar" -#: admin/modules/bibliography/index.php:960 +#: admin/modules/bibliography/index.php:968 #: admin/modules/membership/index.php:568 admin/modules/system/index.php:261 msgid "Remove Image" msgstr "Hapus Gambar" -#: admin/modules/bibliography/index.php:968 +#: admin/modules/bibliography/index.php:976 #: admin/modules/stock_take/st_upload.php:137 #: admin/modules/system/index.php:265 msgid "Choose file" msgstr "Pilih berkas" -#: admin/modules/bibliography/index.php:970 +#: admin/modules/bibliography/index.php:978 msgid "Or download from url" msgstr "Atau unduh dari url" -#: admin/modules/bibliography/index.php:974 admin/modules/system/backup.php:184 +#: admin/modules/bibliography/index.php:982 admin/modules/system/backup.php:176 msgid "Download" msgstr "Unduh" -#: admin/modules/bibliography/index.php:975 +#: admin/modules/bibliography/index.php:983 msgid "Trying search in DuckduckGo" msgstr "Gunakan Layanan DuckduckGo" -#: admin/modules/bibliography/index.php:987 +#: admin/modules/bibliography/index.php:995 msgid "or scan a cover" msgstr "atau pindai sampul" -#: admin/modules/bibliography/index.php:991 +#: admin/modules/bibliography/index.php:999 msgid "Show scan dialog" msgstr "Tunjukkan dialog pindai" -#: admin/modules/bibliography/index.php:992 +#: admin/modules/bibliography/index.php:1000 #: admin/modules/membership/index.php:609 admin/modules/system/app_user.php:374 msgid "Reset" msgstr "Setel ulang" -#: admin/modules/bibliography/index.php:994 +#: admin/modules/bibliography/index.php:1002 msgid "Scan a cover" msgstr "Pindai sampul" -#: admin/modules/bibliography/index.php:995 +#: admin/modules/bibliography/index.php:1003 msgid "Format:" msgstr "Format:" -#: admin/modules/bibliography/index.php:997 +#: admin/modules/bibliography/index.php:1005 msgid "Scan" msgstr "Pindai" -#: admin/modules/bibliography/index.php:998 +#: admin/modules/bibliography/index.php:1006 msgid "Click to show or hide options" msgstr "Klik untuk muncul atau sembunyi pilihan" -#: admin/modules/bibliography/index.php:1000 +#: admin/modules/bibliography/index.php:1008 msgid "History index:" msgstr "Indeks Sejarah:" -#: admin/modules/bibliography/index.php:1000 +#: admin/modules/bibliography/index.php:1008 msgid "Recall" msgstr "Memanggil kembali" -#: admin/modules/bibliography/index.php:1001 +#: admin/modules/bibliography/index.php:1009 msgid "Host:" msgstr "Host:" -#: admin/modules/bibliography/index.php:1001 +#: admin/modules/bibliography/index.php:1009 msgid "Get machine" msgstr "Panggil mesin" -#: admin/modules/bibliography/index.php:1002 +#: admin/modules/bibliography/index.php:1010 msgid "Scanner:" msgstr "Pemindai:" -#: admin/modules/bibliography/index.php:1002 +#: admin/modules/bibliography/index.php:1010 msgid "Default" msgstr "Baku" -#: admin/modules/bibliography/index.php:1003 +#: admin/modules/bibliography/index.php:1011 msgid "Resolution" msgstr "Resolusi" -#: admin/modules/bibliography/index.php:1003 +#: admin/modules/bibliography/index.php:1011 msgid "Horizontal:" msgstr "Horisontal:" -#: admin/modules/bibliography/index.php:1003 +#: admin/modules/bibliography/index.php:1011 msgid "Vertical:" msgstr "Vertikal:" -#: admin/modules/bibliography/index.php:1004 +#: admin/modules/bibliography/index.php:1012 #: admin/modules/membership/index.php:606 admin/modules/system/app_user.php:371 msgid "Capture" msgstr "Ambil Gambar" -#: admin/modules/bibliography/index.php:1004 +#: admin/modules/bibliography/index.php:1012 msgid "Width:" msgstr "Lebar:" -#: admin/modules/bibliography/index.php:1004 +#: admin/modules/bibliography/index.php:1012 msgid "Height:" msgstr "Tinggi:" -#: admin/modules/bibliography/index.php:1005 +#: admin/modules/bibliography/index.php:1013 msgid "Result" msgstr "Hasil" -#: admin/modules/bibliography/index.php:1005 +#: admin/modules/bibliography/index.php:1013 msgid "Max Width:" msgstr "Lebar Maksimal:" -#: admin/modules/bibliography/index.php:1005 +#: admin/modules/bibliography/index.php:1013 msgid "Max Height:" msgstr "Tinggi Maksimal:" -#: admin/modules/bibliography/index.php:1006 +#: admin/modules/bibliography/index.php:1014 msgid "Scan result" msgstr "Hasil pindai" -#: admin/modules/bibliography/index.php:1007 +#: admin/modules/bibliography/index.php:1015 #: admin/modules/bibliography/pop_pattern.php:128 msgid "Preview" msgstr "Pra-tinjau" -#: admin/modules/bibliography/index.php:1007 +#: admin/modules/bibliography/index.php:1015 msgid "Rotate Left" msgstr "Putar ke kiri" -#: admin/modules/bibliography/index.php:1007 +#: admin/modules/bibliography/index.php:1015 msgid "Rotate Right" msgstr "Putar ke kanan" -#: admin/modules/bibliography/index.php:1011 +#: admin/modules/bibliography/index.php:1019 msgid "Image" msgstr "Gambar Sampul" -#: admin/modules/bibliography/index.php:1015 +#: admin/modules/bibliography/index.php:1023 msgid "Add Attachment" msgstr "Tambah Lampiran" -#: admin/modules/bibliography/index.php:1017 -#: admin/modules/bibliography/pop_attach.php:258 +#: admin/modules/bibliography/index.php:1025 +#: admin/modules/bibliography/pop_attach.php:267 #: admin/modules/master_file/label.php:227 #: admin/modules/master_file/label.php:232 #: template/akasia-dz/detail_template.php:170 @@ -2269,23 +2269,23 @@ msgstr "Tambah Lampiran" msgid "File Attachment" msgstr "Lampiran Berkas" -#: admin/modules/bibliography/index.php:1020 +#: admin/modules/bibliography/index.php:1028 msgid "Biblio Relation" msgstr "Relasi biblio" -#: admin/modules/bibliography/index.php:1020 +#: admin/modules/bibliography/index.php:1028 msgid "Add Relation" msgstr "Tambah Relasi" -#: admin/modules/bibliography/index.php:1022 +#: admin/modules/bibliography/index.php:1030 msgid "Related Biblio Data" msgstr "Data biblio terkait" -#: admin/modules/bibliography/index.php:1104 +#: admin/modules/bibliography/index.php:1112 msgid "You are going to edit biblio data" msgstr "Anda akan mengubah data biblio" -#: admin/modules/bibliography/index.php:1104 +#: admin/modules/bibliography/index.php:1112 #: admin/modules/bibliography/item.php:362 #: admin/modules/bibliography/item.php:410 #: admin/modules/bibliography/item.php:419 @@ -2302,33 +2302,33 @@ msgstr "Anda akan mengubah data biblio" msgid "Last Updated" msgstr "Terakhir diubah" -#: admin/modules/bibliography/index.php:1158 +#: admin/modules/bibliography/index.php:1166 msgid "Current url is not valid or your internet is down." msgstr "URL ini tidak tersedia atau koneksi internet Anda terputus." -#: admin/modules/bibliography/index.php:1211 -#: admin/modules/bibliography/index.php:1217 -#: admin/modules/bibliography/index.php:1237 -#: admin/modules/bibliography/index.php:1243 +#: admin/modules/bibliography/index.php:1219 +#: admin/modules/bibliography/index.php:1225 +#: admin/modules/bibliography/index.php:1245 +#: admin/modules/bibliography/index.php:1251 #: admin/modules/stock_take/st_report.php:84 #: admin/modules/stock_take/st_report.php:88 template/default/tinfo.inc.php:78 msgid "None" msgstr "Tidak Ada" -#: admin/modules/bibliography/index.php:1211 -#: admin/modules/bibliography/index.php:1217 -#: admin/modules/bibliography/index.php:1237 -#: admin/modules/bibliography/index.php:1243 +#: admin/modules/bibliography/index.php:1219 +#: admin/modules/bibliography/index.php:1225 +#: admin/modules/bibliography/index.php:1245 +#: admin/modules/bibliography/index.php:1251 #: admin/modules/bibliography/printed_card.php:212 #: admin/modules/reporting/customs/titles_list.php:128 #: admin/modules/reporting/customs/titles_list.php:256 msgid "Copies" msgstr "Salin" -#: admin/modules/bibliography/index.php:1212 -#: admin/modules/bibliography/index.php:1218 -#: admin/modules/bibliography/index.php:1238 -#: admin/modules/bibliography/index.php:1244 +#: admin/modules/bibliography/index.php:1220 +#: admin/modules/bibliography/index.php:1226 +#: admin/modules/bibliography/index.php:1246 +#: admin/modules/bibliography/index.php:1252 #: admin/modules/circulation/loan_rules.php:224 #: admin/modules/circulation/loan_rules.php:245 #: admin/modules/circulation/loan_rules.php:252 @@ -2463,11 +2463,11 @@ msgstr "Ekspor data eksemplar ke dalam berkas CSV" msgid "File type not allowed or the size is more than" msgstr "Tipe berkas tidak diizinkan atau ukurannya melebih ketentuan" -#: admin/modules/bibliography/item_import.php:197 +#: admin/modules/bibliography/item_import.php:206 msgid "Item Import tool" msgstr "Perangkat Impor Eksemplar" -#: admin/modules/bibliography/item_import.php:200 +#: admin/modules/bibliography/item_import.php:209 msgid "Import for item data from CSV file" msgstr "Impor data eksemplar dari data CSV" @@ -2770,88 +2770,92 @@ msgstr "" "Maaf, dari %s tidak ada hasil ATAU kemungkinan hasil dan detail XML " "dinonaktifkan." -#: admin/modules/bibliography/pop_attach.php:99 +#: admin/modules/bibliography/pop_attach.php:101 msgid "Upload FAILED! Forbidden file type or file size too big!" msgstr "Unggah GAGAL! Jenis berkas terlarang atau ukuran terlalu besar!" -#: admin/modules/bibliography/pop_attach.php:149 +#: admin/modules/bibliography/pop_attach.php:156 msgid "File Attachment data updated!" msgstr "Data berkas lampiran berhasil diperbarui!" -#: admin/modules/bibliography/pop_attach.php:154 +#: admin/modules/bibliography/pop_attach.php:161 msgid "File Attachment data FAILED to update!" msgstr "Data berkas lampiran GAGAL diperbarui!" -#: admin/modules/bibliography/pop_attach.php:158 -#: admin/modules/bibliography/pop_attach.php:173 +#: admin/modules/bibliography/pop_attach.php:165 +#: admin/modules/bibliography/pop_attach.php:180 msgid "File Attachment uploaded succesfully!" msgstr "Berkas Lampiran berhasil diunggah!" -#: admin/modules/bibliography/pop_attach.php:163 +#: admin/modules/bibliography/pop_attach.php:170 msgid "File Attachment data FAILED to save!" msgstr "Berkas Lampiran GAGAL disimpan!" -#: admin/modules/bibliography/pop_attach.php:183 +#: admin/modules/bibliography/pop_attach.php:190 msgid "Upload Now" msgstr "Unggah Sekarang" -#: admin/modules/bibliography/pop_attach.php:213 +#: admin/modules/bibliography/pop_attach.php:220 msgid "Repository ROOT" msgstr "Repositori ROOT" -#: admin/modules/bibliography/pop_attach.php:223 +#: admin/modules/bibliography/pop_attach.php:230 msgid "Repo. Directory" msgstr "Direktori Repositori" -#: admin/modules/bibliography/pop_attach.php:234 +#: admin/modules/bibliography/pop_attach.php:241 msgid "File To Attach" msgstr "Berkas untuk dilampirkan" -#: admin/modules/bibliography/pop_attach.php:237 +#: admin/modules/bibliography/pop_attach.php:244 msgid "URL" msgstr "URL" -#: admin/modules/bibliography/pop_attach.php:240 +#: admin/modules/bibliography/pop_attach.php:247 msgid "Work for embedded link or video attachment" msgstr "Digunakan bersama tempelan pranala atau lampiran video" -#: admin/modules/bibliography/pop_attach.php:241 +#: admin/modules/bibliography/pop_attach.php:248 msgid "Link" msgstr "Pranala" -#: admin/modules/bibliography/pop_attach.php:241 +#: admin/modules/bibliography/pop_attach.php:248 msgid "Popup" msgstr "Pop-up" -#: admin/modules/bibliography/pop_attach.php:241 +#: admin/modules/bibliography/pop_attach.php:248 msgid "Embed" msgstr "Tempel" -#: admin/modules/bibliography/pop_attach.php:242 +#: admin/modules/bibliography/pop_attach.php:249 msgid "Placement" msgstr "Penempatan" -#: admin/modules/bibliography/pop_attach.php:245 +#: admin/modules/bibliography/pop_attach.php:252 #: admin/modules/reporting/customs/member_fines_list.php:188 #: admin/modules/reporting/customs/procurement_report.php:125 msgid "Description" msgstr "Deskripsi" -#: admin/modules/bibliography/pop_attach.php:247 +#: admin/modules/bibliography/pop_attach.php:254 +msgid "File Password" +msgstr "Kata sandi Berkas" + +#: admin/modules/bibliography/pop_attach.php:256 msgid "Public" msgstr "Publik" -#: admin/modules/bibliography/pop_attach.php:248 +#: admin/modules/bibliography/pop_attach.php:257 msgid "Private" msgstr "Tertutup" -#: admin/modules/bibliography/pop_attach.php:249 +#: admin/modules/bibliography/pop_attach.php:258 #: admin/modules/reporting/customs/dl_counter.php:113 #: admin/modules/reporting/customs/dl_counter.php:200 msgid "Access" msgstr "Akses" -#: admin/modules/bibliography/pop_attach.php:256 +#: admin/modules/bibliography/pop_attach.php:265 msgid "Access Limit by Member Type" msgstr "Pembatasan Akses berdasarkan Tipe Keanggotaan" @@ -2987,7 +2991,8 @@ msgid "Settings saved" msgstr "Setelan tersimpan" #: admin/modules/bibliography/print_settings.php:78 -#: admin/modules/system/holiday.php:334 admin/modules/system/index.php:237 +#: admin/modules/system/envsetting.php:113 admin/modules/system/holiday.php:364 +#: admin/modules/system/index.php:237 admin/modules/system/mailsetting.php:169 #: admin/modules/system/membercard_theme.php:107 #: admin/modules/system/theme.php:138 admin/modules/system/ucsetting.php:76 msgid "Save Settings" @@ -3598,6 +3603,7 @@ msgstr "Reservasi" #: admin/modules/circulation/circulation_action.php:564 #: admin/modules/circulation/circulation_action.php:566 +#: admin/modules/reporting/customs/overdued_list.php:209 msgid "Fines" msgstr "Denda" @@ -4761,7 +4767,7 @@ msgstr "Kode" #: admin/modules/master_file/rda_cmc.php:189 #: admin/modules/master_file/rda_cmc.php:209 #: admin/modules/master_file/rda_cmc.php:213 lib/contents/librarian.inc.php:47 -#: sysconfig.inc.php:694 +#: sysconfig.inc.php:701 msgid "Name" msgstr "Nama" @@ -4940,7 +4946,7 @@ msgstr "Kontak" #: admin/modules/membership/index.php:510 #: admin/modules/reporting/customs/due_date_warning.php:152 #: admin/modules/reporting/customs/member_loan_list.php:185 -#: admin/modules/reporting/customs/overdued_list.php:190 +#: admin/modules/reporting/customs/overdued_list.php:194 #: files/membercard/classic/membercard.php:286 #: files/membercard/old/membercard.php:331 msgid "Phone Number" @@ -5044,7 +5050,7 @@ msgstr "Baris pertama adalah nama kolom" #: admin/modules/membership/index.php:98 msgid "Member ID, Name and Birthday cannot be empty" -msgstr "ID dan Nama Anggota dan Tanggal Lahit tidak boleh kosong" +msgstr "ID dan Nama Anggota dan Tanggal Lahir tidak boleh kosong" #: admin/modules/membership/index.php:101 admin/modules/system/app_user.php:99 #: lib/contents/login.inc.php:163 lib/contents/newpass.inc.php:57 @@ -5203,7 +5209,7 @@ msgstr "Foto" #: admin/modules/membership/index.php:711 #: admin/modules/reporting/customs/due_date_warning.php:152 #: admin/modules/reporting/customs/member_loan_list.php:185 -#: admin/modules/reporting/customs/overdued_list.php:190 +#: admin/modules/reporting/customs/overdued_list.php:194 #: files/membercard/old/membercard.php:322 msgid "E-mail" msgstr "Surel" @@ -5960,15 +5966,15 @@ msgstr "Tanggal Pendaftaran Sejak" msgid "Register Date Until" msgstr "Tanggal Pendaftaran Hingga" -#: admin/modules/reporting/customs/overdued_list.php:190 +#: admin/modules/reporting/customs/overdued_list.php:194 msgid "Send Notification e-mail" msgstr "Kirim surel Pemberitahuan" -#: admin/modules/reporting/customs/overdued_list.php:195 +#: admin/modules/reporting/customs/overdued_list.php:208 msgid "Book Price" msgstr "Harga Buku" -#: admin/modules/reporting/customs/overdued_list.php:196 +#: admin/modules/reporting/customs/overdued_list.php:209 msgid "day(s)" msgstr "hari" @@ -6110,6 +6116,7 @@ msgstr "" "Laporan Penghitung Pengunjung untuk tahun {selectedYear}" #: admin/modules/reporting/customs/visitor_report_day.php:61 +#: admin/modules/reporting/customs/visitor_report_day.php:128 msgid "Visitor Report by Day" msgstr "Laporan Pengunjung berdasarkan Hari" @@ -6891,7 +6898,7 @@ msgstr "Data Pengguna Baru Berhasil Disimpan" msgid "User Data FAILED to Save. Please Contact System Administrator" msgstr "Data Pengguna Baru GAGAL Disimpan. Hubungi Administrator Sistem" -#: admin/modules/system/app_user.php:262 admin/modules/system/submenu.php:48 +#: admin/modules/system/app_user.php:262 admin/modules/system/submenu.php:50 msgid "Librarian & System Users" msgstr "Pustakawan & Pengguna Sistem" @@ -6937,7 +6944,7 @@ msgid "Last Login" msgstr "Terakhir kali Masuk" #: admin/modules/system/backup.php:103 admin/modules/system/backup.php:106 -#: admin/modules/system/backup.php:117 admin/modules/system/submenu.php:55 +#: admin/modules/system/backup.php:117 admin/modules/system/submenu.php:57 msgid "Database Backup" msgstr "Salinan Pangkalan Data" @@ -6945,23 +6952,23 @@ msgstr "Salinan Pangkalan Data" msgid "Start New Backup" msgstr "Mulai Salinan Baru" -#: admin/modules/system/backup.php:148 admin/modules/system/backup.php:156 +#: admin/modules/system/backup.php:147 msgid "Backup Executor" msgstr "Pelaksana Pencadangan" -#: admin/modules/system/backup.php:149 admin/modules/system/backup.php:157 +#: admin/modules/system/backup.php:148 msgid "Backup Time" msgstr "Waktu Pencadangan" -#: admin/modules/system/backup.php:150 admin/modules/system/backup.php:158 +#: admin/modules/system/backup.php:149 msgid "Backup File Location" msgstr "Lokasi Berkas Cadangan" -#: admin/modules/system/backup.php:151 admin/modules/system/backup.php:159 +#: admin/modules/system/backup.php:150 msgid "File Size" msgstr "Ukuran Berkas" -#: admin/modules/system/backup.php:176 +#: admin/modules/system/backup.php:168 msgid "File not found" msgstr "Berkas tidak ada" @@ -6990,7 +6997,7 @@ msgstr "Hubungi Admin Sistem untuk mengarahkan direktori backup" #: admin/modules/system/barcode_generator.php:102 #: admin/modules/system/barcode_generator.php:134 -#: admin/modules/system/submenu.php:53 +#: admin/modules/system/submenu.php:55 msgid "Barcode Generator" msgstr "Pembuat Barkod" @@ -7149,7 +7156,7 @@ msgstr "Data Konten berhasil disimpan" msgid "Content data FAILED to save!" msgstr "Data Konten GAGAL disimpan!" -#: admin/modules/system/content.php:169 admin/modules/system/submenu.php:38 +#: admin/modules/system/content.php:169 admin/modules/system/submenu.php:40 msgid "Content" msgstr "Konten" @@ -7192,7 +7199,7 @@ msgstr "Anda akan mengubah data Konten" #: admin/modules/system/custom_field.php:118 #: admin/modules/system/custom_field.php:150 #: admin/modules/system/custom_field.php:154 -#: admin/modules/system/submenu.php:36 +#: admin/modules/system/submenu.php:37 msgid "Custom Field" msgstr "Ruas Tambahan" @@ -7300,60 +7307,99 @@ msgstr "" "Peringatan : Memperbarui daftar data atau tabel utama akan " "menghapus konten dalam tabel ini" -#: admin/modules/system/envinfo.php:50 admin/modules/system/index.php:248 +#: admin/modules/system/envinfo.php:50 +msgid "SLiMS Environment Mode" +msgstr "Moda Lingkungan SLiMS" + +#: admin/modules/system/envinfo.php:51 admin/modules/system/index.php:248 msgid "SLiMS Version" msgstr "Versi SLiMS" -#: admin/modules/system/envinfo.php:51 +#: admin/modules/system/envinfo.php:52 msgid "Operating System" msgstr "Sistem Operasi" -#: admin/modules/system/envinfo.php:52 +#: admin/modules/system/envinfo.php:53 msgid "OS Architecture" msgstr "Arsitektur OS" -#: admin/modules/system/envinfo.php:53 +#: admin/modules/system/envinfo.php:54 msgid "Web Server" msgstr "Peladen Web" -#: admin/modules/system/envinfo.php:54 +#: admin/modules/system/envinfo.php:55 msgid "PHP version" msgstr "Versi PHP" -#: admin/modules/system/envinfo.php:55 +#: admin/modules/system/envinfo.php:56 msgid "MySQL Database version" msgstr "Versi Pangkalan data MySQL" -#: admin/modules/system/envinfo.php:56 +#: admin/modules/system/envinfo.php:57 msgid "MySQL Client version" msgstr "Versi Klien MySQL" -#: admin/modules/system/envinfo.php:57 +#: admin/modules/system/envinfo.php:58 msgid "Browser/User Agent" msgstr "Peramban/Agen Pengguna" -#: admin/modules/system/envinfo.php:58 +#: admin/modules/system/envinfo.php:59 msgid "Hostname" msgstr "Hostname" -#: admin/modules/system/envinfo.php:59 +#: admin/modules/system/envinfo.php:60 msgid "jQuery version" msgstr "versi JQuery" -#: admin/modules/system/envinfo.php:60 +#: admin/modules/system/envinfo.php:61 msgid "HTML5 Support?" msgstr "Mendukung HTML5?" -#: admin/modules/system/envinfo.php:66 admin/modules/system/submenu.php:32 +#: admin/modules/system/envinfo.php:67 admin/modules/system/submenu.php:32 msgid "System Environment" msgstr "Lingkungan Sistem" -#: admin/modules/system/envinfo.php:69 +#: admin/modules/system/envinfo.php:70 msgid "" "Information on SLiMS System Environment. Use this to support troubleshotting " "problem." msgstr "Informasi terkait sistem SLiMS. Digunakan untuk dukungan perbaikan." +#: admin/modules/system/envsetting.php:49 +#: admin/modules/system/mailsetting.php:64 +msgid "Error" +msgstr "Galat" + +#: admin/modules/system/envsetting.php:49 +msgid "sysconfig.env.inc.php file is not writeable!" +msgstr "tidak dapat menulis ke berkas sysconfig.env.inc.php!" + +#: admin/modules/system/envsetting.php:86 +#: admin/modules/system/mailsetting.php:130 +#: admin/modules/system/mailsetting.php:132 +msgid "Success" +msgstr "Berhasil" + +#: admin/modules/system/envsetting.php:86 +msgid "Configuration has been saved!" +msgstr "Telah tersimpan konfigurasi!" + +#: admin/modules/system/envsetting.php:99 +msgid "System Environment Settings" +msgstr "Setelan Lingkungan Sistem" + +#: admin/modules/system/envsetting.php:102 +msgid "SLiMS Environment preferences." +msgstr "Pilihan Lingkungan SLiMS." + +#: admin/modules/system/holiday.php:58 admin/modules/system/holiday.php:63 +#: admin/modules/system/holiday.php:78 admin/modules/system/holiday.php:85 +#: admin/modules/system/holiday.php:92 admin/modules/system/holiday.php:99 +#: admin/modules/system/holiday.php:124 admin/modules/system/holiday.php:160 +#: admin/modules/system/holiday.php:163 admin/modules/system/holiday.php:174 +msgid "Holiday Settings" +msgstr "Setelan Hari Libur" + #: admin/modules/system/holiday.php:58 msgid "Holiday description can't be empty!" msgstr "Keterangan hari mohon diisi!" @@ -7383,11 +7429,7 @@ msgstr "" msgid "Holiday FAILED to Save. Please Contact System Administrator" msgstr "Hari Libur GAGAL Disimpan. Hubungi administrator Sistem" -#: admin/modules/system/holiday.php:174 -msgid "Holiday Settings" -msgstr "Setelan Hari Libur" - -#: admin/modules/system/holiday.php:179 admin/modules/system/submenu.php:52 +#: admin/modules/system/holiday.php:179 admin/modules/system/submenu.php:54 msgid "Holiday Setting" msgstr "Setelan Hari Libur" @@ -7421,48 +7463,48 @@ msgstr "Anda akan menyunting hari libur" msgid "Day name" msgstr "Nama hari" -#: admin/modules/system/holiday.php:278 -msgid "Maximum 6 day can be set as holiday!" -msgstr "Hari libur bisa diatur maksimal 6 hari!" - -#: admin/modules/system/holiday.php:292 -msgid "Holiday settings saved" -msgstr "Aturan hari libur tersimpan" +#: admin/modules/system/holiday.php:262 admin/modules/system/holiday.php:359 +#: simbio2/simbio_UTILS/simbio_date.inc.php:246 +msgid "Sunday" +msgstr "Minggu" -#: admin/modules/system/holiday.php:321 +#: admin/modules/system/holiday.php:265 admin/modules/system/holiday.php:351 #: simbio2/simbio_UTILS/simbio_date.inc.php:247 msgid "Monday" msgstr "Senin" -#: admin/modules/system/holiday.php:322 +#: admin/modules/system/holiday.php:268 admin/modules/system/holiday.php:352 #: simbio2/simbio_UTILS/simbio_date.inc.php:248 msgid "Tuesday" msgstr "Selasa" -#: admin/modules/system/holiday.php:323 +#: admin/modules/system/holiday.php:271 admin/modules/system/holiday.php:353 #: simbio2/simbio_UTILS/simbio_date.inc.php:249 msgid "Wednesday" msgstr "Rabu" -#: admin/modules/system/holiday.php:325 +#: admin/modules/system/holiday.php:274 admin/modules/system/holiday.php:355 #: simbio2/simbio_UTILS/simbio_date.inc.php:250 msgid "Thursday" msgstr "Kamis" -#: admin/modules/system/holiday.php:326 +#: admin/modules/system/holiday.php:277 admin/modules/system/holiday.php:356 #: simbio2/simbio_UTILS/simbio_date.inc.php:251 msgid "Friday" msgstr "Jumat" -#: admin/modules/system/holiday.php:327 +#: admin/modules/system/holiday.php:280 admin/modules/system/holiday.php:357 #: simbio2/simbio_UTILS/simbio_date.inc.php:252 msgid "Saturday" msgstr "Sabtu" -#: admin/modules/system/holiday.php:329 -#: simbio2/simbio_UTILS/simbio_date.inc.php:246 -msgid "Sunday" -msgstr "Minggu" +#: admin/modules/system/holiday.php:308 +msgid "Maximum 6 day can be set as holiday!" +msgstr "Hari libur bisa diatur maksimal 6 hari!" + +#: admin/modules/system/holiday.php:322 +msgid "Holiday settings saved" +msgstr "Aturan hari libur tersimpan" #: admin/modules/system/index.php:78 admin/modules/system/index.php:96 #: admin/modules/system/index.php:119 admin/modules/system/index.php:228 @@ -7594,6 +7636,98 @@ msgstr "Metode pemesanan" msgid "Reserve for item on loan only" msgstr "Pemesanan hanya untuk eksemplar terpinjam" +#: admin/modules/system/mailsetting.php:53 +msgid "NB : Password is hidden for security reason" +msgstr "PS : Untuk alasan keamanan, kata sandi tidak diperlihatkan" + +#: admin/modules/system/mailsetting.php:54 +msgid "Example" +msgstr "Contoh" + +#: admin/modules/system/mailsetting.php:64 +#: admin/modules/system/mailsetting.php:159 +msgid "Directory config is not writeable." +msgstr "Tidak dapat menulis ke dalam direktori config." + +#: admin/modules/system/mailsetting.php:90 +#: admin/modules/system/mailsetting.php:149 +msgid "E-Mail Configuration" +msgstr "Konfigurasi surel" + +#: admin/modules/system/mailsetting.php:90 +#: admin/modules/system/ucsetting.php:52 +msgid "Settings inserted." +msgstr "Setelan tersimpan." + +#: admin/modules/system/mailsetting.php:155 +msgid "E-Mail test" +msgstr "Coba kirim surel" + +#: admin/modules/system/mailsetting.php:155 +msgid "Modify E-Mail preferences" +msgstr "Ganti pilihan surel" + +#: admin/modules/system/mailsetting.php:160 +msgid "" +"Make the following files and directories (and their contents) writeable (i." +"e., by changing the owner or permissions with chown or chmod)" +msgstr "" +"Direktori dan berkas-berkas di dalamnya harus dapat ditulis oleh sistem " +"(lakukan perubahan pada izin kepemilikan, contoh, gunakan chown atau chmod " +"pada Linux)" + +#: admin/modules/system/mailsetting.php:176 +msgid "Production" +msgstr "Produksi" + +#: admin/modules/system/mailsetting.php:177 +msgid "Development" +msgstr "Pengembangan" + +#: admin/modules/system/mailsetting.php:179 +msgid "Environment" +msgstr "Lingkungan" + +#: admin/modules/system/mailsetting.php:182 +msgid "SMTP Encryption" +msgstr "Enkripsi SMTP" + +#: admin/modules/system/mailsetting.php:185 +msgid "SMTP Server address" +msgstr "Alamat peladen SMTP" + +#: admin/modules/system/mailsetting.php:188 +msgid "SMTP Port" +msgstr "Porta SMTP" + +#: admin/modules/system/mailsetting.php:191 +msgid "Authentication Username" +msgstr "Nama pengguna terautentikasi" + +#: admin/modules/system/mailsetting.php:194 +msgid "Authentication Password" +msgstr "Kata sandi terautentikasi" + +#: admin/modules/system/mailsetting.php:194 +msgid "" +"Password does not appearance for security reason. If you want to look it, " +"open sysconfig.mail.inc.php file." +msgstr "" +"Untuk alasan keamanan, kata sandi tidak ditampilkan. Lihat berkas sysconfig." +"mail.inc.php untuk melihat kata sandi yang telah dimasukkan." + +#: admin/modules/system/mailsetting.php:197 +msgid "Email Sender Address" +msgstr "Alamat Surel Pengirim" + +#: admin/modules/system/mailsetting.php:200 +msgid "Email Sender Label" +msgstr "Nama Pengirim Surel" + +#: admin/modules/system/mailsetting.php:205 +msgid "Do Test" +msgstr "Coba kirim surel" + #: admin/modules/system/membercard_theme.php:81 #: admin/modules/system/theme.php:105 msgid "Error saving custom data!" @@ -7661,7 +7795,7 @@ msgstr "Data Modul Baru Berhasil Disimpan" msgid "Module Data FAILED to Save. Please Contact System Administrator" msgstr "Data Modul GAGAL Disimpan. Hubungi administrator Sistem" -#: admin/modules/system/module.php:142 admin/modules/system/submenu.php:46 +#: admin/modules/system/module.php:142 admin/modules/system/submenu.php:48 msgid "Modules" msgstr "Modul" @@ -7768,34 +7902,50 @@ msgid "Information about System Environment" msgstr "Informasi terkait Sistem" #: admin/modules/system/submenu.php:33 +msgid "System Environment Setting" +msgstr "Setelan Lingkungan Sistem" + +#: admin/modules/system/submenu.php:33 +msgid "Configure System Environment Mode" +msgstr "Moda Konfigurasi Lingkungan Sistem" + +#: admin/modules/system/submenu.php:34 msgid "UCS Setting" msgstr "Pengaturan UCS" -#: admin/modules/system/submenu.php:33 +#: admin/modules/system/submenu.php:34 msgid "Configure UCS Preferences" msgstr "Konfigurasi UCS" -#: admin/modules/system/submenu.php:35 +#: admin/modules/system/submenu.php:36 msgid "Plugins" msgstr "Plugin" -#: admin/modules/system/submenu.php:36 +#: admin/modules/system/submenu.php:37 msgid "Configure custom field" msgstr "Konfigurasi ruas tambahan" -#: admin/modules/system/submenu.php:42 admin/modules/system/submenu.php:44 +#: admin/modules/system/submenu.php:38 +msgid "E-Mail Setting" +msgstr "Pengaturan Surel" + +#: admin/modules/system/submenu.php:38 +msgid "Configure E-Mail Preferences" +msgstr "Konfigurasi Surel" + +#: admin/modules/system/submenu.php:44 admin/modules/system/submenu.php:46 msgid "Biblio Indexes" msgstr "Indeks Biblio" -#: admin/modules/system/submenu.php:42 admin/modules/system/submenu.php:44 +#: admin/modules/system/submenu.php:44 admin/modules/system/submenu.php:46 msgid "Bibliographic Indexes management" msgstr "Pengaturan Indeks Bibliografi" -#: admin/modules/system/submenu.php:46 +#: admin/modules/system/submenu.php:48 msgid "Configure Application Modules" msgstr "Konfigurasi Modul Aplikasi" -#: admin/modules/system/submenu.php:47 admin/modules/system/user_group.php:55 +#: admin/modules/system/submenu.php:49 admin/modules/system/user_group.php:55 #: admin/modules/system/user_group.php:96 #: admin/modules/system/user_group.php:99 #: admin/modules/system/user_group.php:132 @@ -7806,28 +7956,28 @@ msgstr "Konfigurasi Modul Aplikasi" msgid "User Group" msgstr "Kelompok Pengguna" -#: admin/modules/system/submenu.php:47 +#: admin/modules/system/submenu.php:49 msgid "Manage Group of Application User" msgstr "Kelola Kelompok Pengguna Aplikasi" -#: admin/modules/system/submenu.php:48 +#: admin/modules/system/submenu.php:50 msgid "Manage Application User or Library Staff" msgstr "Kelola Pengguna Aplikasi atau Staf Perpustakaan" -#: admin/modules/system/submenu.php:52 +#: admin/modules/system/submenu.php:54 msgid "Configure Holiday Setting" msgstr "Konfigurasi Hari Libur" -#: admin/modules/system/submenu.php:54 admin/modules/system/sys_log.php:67 +#: admin/modules/system/submenu.php:56 admin/modules/system/sys_log.php:67 #: admin/modules/system/sys_log.php:77 msgid "System Log" msgstr "Catatan Sistem" -#: admin/modules/system/submenu.php:54 +#: admin/modules/system/submenu.php:56 msgid "View Application System Log" msgstr "Lihat Catatan Aplikasi Sistem" -#: admin/modules/system/submenu.php:55 +#: admin/modules/system/submenu.php:57 msgid "Backup Application Database" msgstr "Buat Salinan Pangkalan Data Aplikasi" @@ -7891,10 +8041,6 @@ msgstr "Pengaturan tersimpan." msgid "Failed save settings!" msgstr "Gagal menyimpan pengaturan!" -#: admin/modules/system/ucsetting.php:52 -msgid "Settings inserted." -msgstr "Setelan tersimpan." - #: admin/modules/system/ucsetting.php:65 msgid "Modify UCS preferences" msgstr "Ubah Preferensi UCS" @@ -8116,11 +8262,11 @@ msgstr "" "Akses Katalog Publik Daring - Gunakan fasilitas pencarian untuk mempercepat " "penemuan data katalog" -#: index.php:56 +#: index.php:58 msgid "You are currently Logged on as member" msgstr "Anda saat ini masuk sebagai anggota" -#: index.php:56 lib/contents/member.inc.php:712 +#: index.php:58 lib/contents/member.inc.php:712 msgid "LOGOUT" msgstr "KELUAR" @@ -8186,7 +8332,7 @@ msgstr "" "Ditemukan {biblio_list->num_rows} dari pencarian Anda " "melalui kata kunci" -#: lib/contents/default.inc.php:198 +#: lib/contents/default.inc.php:207 msgid "" "You currently on page {page} of {total_pages} page(s)" @@ -8194,7 +8340,7 @@ msgstr "" "Saat ini anda berada pada halaman {page} dari total " "{total_pages} halaman" -#: lib/contents/default.inc.php:219 +#: lib/contents/default.inc.php:228 msgid "Did you mean:" msgstr "Yang Anda maksud:" @@ -8455,11 +8601,11 @@ msgstr "Tidak ada judul untuk dipesan" #: lib/contents/member.inc.php:631 msgid "Reservation not allowed" -msgstr "Tidak bisa dipesan" +msgstr "Anda tidak diizinkan untuk memesan" #: lib/contents/member.inc.php:639 msgid "Reserve limit reached" -msgstr "Tidak bisa memesan" +msgstr "Pemesanan Anda sudah melebihi batas" #: lib/contents/member.inc.php:640 #, php-format @@ -8601,7 +8747,7 @@ msgstr "Detail XML" #: lib/contents/show_detail.inc.php:119 #: template/akasia-dz/biblio_list_template.php:85 #: template/akasia/biblio_list_template.php:86 -#: template/default/biblio_list_template.php:120 +#: template/default/biblio_list_template.php:123 #: template/lightweight/biblio_list_template.php:85 msgid "Citation for: {title}" msgstr "Sitasi untuk: {title}" @@ -8610,43 +8756,43 @@ msgstr "Sitasi untuk: {title}" msgid "Cite this" msgstr "Kutip ini" -#: lib/contents/visitor.inc.php:161 +#: lib/contents/visitor.inc.php:166 msgid ", thank you for inserting your data to our visitor log" msgstr ", terimakasih telah memasukkan data Anda pada catatan pengunjung kami" -#: lib/contents/visitor.inc.php:163 +#: lib/contents/visitor.inc.php:168 msgid "" "Your membership already EXPIRED, please renew/extend your membership " "immediately" msgstr "" "Masa berlaku keanggotaan sudah BERAKHIR! Harap perpanjang keanggotaan anda" -#: lib/contents/visitor.inc.php:166 +#: lib/contents/visitor.inc.php:171 msgid "Welcome back" msgstr "Selamat datang kembali" -#: lib/contents/visitor.inc.php:168 +#: lib/contents/visitor.inc.php:173 msgid "Sorry, Please fill institution field if you are not library member" msgstr "Maaf, masukkan nama lembaga apabila Anda bukan anggota perpustakaan" -#: lib/contents/visitor.inc.php:170 +#: lib/contents/visitor.inc.php:175 msgid "Error inserting counter data to database!" msgstr "" "Terjadi galat dalam memasukkan data penghitung ke dalam pangkalan data!" -#: lib/contents/visitor.inc.php:186 +#: lib/contents/visitor.inc.php:191 msgid "Welcome to our library." msgstr "Selamat datang di perpustakaan kami." -#: lib/contents/visitor.inc.php:187 template/default/visitor_template.php:31 +#: lib/contents/visitor.inc.php:192 template/default/visitor_template.php:31 msgid "Please fill your member ID or name." msgstr "Harap isi ID anggota atau nama Anda." -#: lib/contents/visitor.inc.php:188 +#: lib/contents/visitor.inc.php:193 msgid "Error while inserting counter data to database." msgstr "Galat saat memasukkan data pengunjung ke dalam pangkalan data." -#: lib/contents/visitor.inc.php:266 template/akasia-dz/visitor_template.php:32 +#: lib/contents/visitor.inc.php:271 template/akasia-dz/visitor_template.php:32 #: template/akasia/visitor_template.php:32 #: template/lightweight/visitor_template.php:32 msgid "Visitor Counter" @@ -8672,9 +8818,9 @@ msgstr "Klik disini untuk mencari dokumen lain dari pengarang ini" msgid "Click to view others documents with this subject" msgstr "Klik di sini untuk mencari dokumen lain dengan subjek ini" -#: lib/detail.inc.php:462 template/akasia-dz/biblio_list_template.php:166 -#: template/akasia/biblio_list_template.php:167 -#: template/lightweight/biblio_list_template.php:166 +#: lib/detail.inc.php:462 template/akasia-dz/biblio_list_template.php:169 +#: template/akasia/biblio_list_template.php:170 +#: template/lightweight/biblio_list_template.php:169 msgid "Share to" msgstr "Bagikan" @@ -8838,83 +8984,83 @@ msgstr "Hal. Akhir" msgid "No Data" msgstr "Tidak Ada Data" -#: sysconfig.inc.php:687 +#: sysconfig.inc.php:694 msgid "Personal Name" msgstr "Nama Orang" -#: sysconfig.inc.php:688 +#: sysconfig.inc.php:695 msgid "Organizational Body" msgstr "Badan Organisasi" -#: sysconfig.inc.php:689 +#: sysconfig.inc.php:696 msgid "Conference" msgstr "Konferensi" -#: sysconfig.inc.php:692 +#: sysconfig.inc.php:699 msgid "Topic" msgstr "Topik" -#: sysconfig.inc.php:693 +#: sysconfig.inc.php:700 msgid "Geographic" msgstr "Geografis" -#: sysconfig.inc.php:695 +#: sysconfig.inc.php:702 msgid "Temporal" msgstr "Masa" -#: sysconfig.inc.php:696 +#: sysconfig.inc.php:703 msgid "Genre" msgstr "Aliran" -#: sysconfig.inc.php:697 +#: sysconfig.inc.php:704 msgid "Occupation" msgstr "Pekerjaan" -#: sysconfig.inc.php:700 +#: sysconfig.inc.php:707 msgid "Primary Author" msgstr "Pengarang Utama" -#: sysconfig.inc.php:701 +#: sysconfig.inc.php:708 msgid "Additional Author" msgstr "Pengarang Tambahan" -#: sysconfig.inc.php:702 +#: sysconfig.inc.php:709 msgid "Editor" msgstr "Penyunting" -#: sysconfig.inc.php:703 +#: sysconfig.inc.php:710 msgid "Translator" msgstr "Penerjemah" -#: sysconfig.inc.php:704 +#: sysconfig.inc.php:711 msgid "Director" msgstr "Direktur" -#: sysconfig.inc.php:705 +#: sysconfig.inc.php:712 msgid "Producer" msgstr "Produser" -#: sysconfig.inc.php:706 +#: sysconfig.inc.php:713 msgid "Composer" msgstr "Penggubah" -#: sysconfig.inc.php:707 +#: sysconfig.inc.php:714 msgid "Illustrator" msgstr "Ilustrator" -#: sysconfig.inc.php:708 +#: sysconfig.inc.php:715 msgid "Creator" msgstr "Pencipta" -#: sysconfig.inc.php:709 +#: sysconfig.inc.php:716 msgid "Contributor" msgstr "Kontributor" -#: sysconfig.inc.php:713 +#: sysconfig.inc.php:720 msgid "Senior Librarian" msgstr "Pustakawan Senior" -#: sysconfig.inc.php:714 +#: sysconfig.inc.php:721 msgid "Library Staff" msgstr "Staf Perpustakaan" @@ -8922,7 +9068,7 @@ msgstr "Staf Perpustakaan" #: template/akasia-dz/biblio_list_template.php:79 #: template/akasia/biblio_list_template.php:50 #: template/akasia/biblio_list_template.php:80 -#: template/default/biblio_list_template.php:99 +#: template/default/biblio_list_template.php:102 #: template/lightweight/biblio_list_template.php:50 #: template/lightweight/biblio_list_template.php:79 msgid "View record detail description for this title" @@ -8936,68 +9082,68 @@ msgstr "Tampilkan penjelasan lengkap dalam Format XML" #: template/akasia-dz/biblio_list_template.php:85 #: template/akasia/biblio_list_template.php:86 -#: template/default/biblio_list_template.php:120 +#: template/default/biblio_list_template.php:123 #: template/lightweight/biblio_list_template.php:85 msgid "Cite" msgstr "Sitasi" -#: template/akasia-dz/biblio_list_template.php:144 -#: template/akasia/biblio_list_template.php:145 -#: template/lightweight/biblio_list_template.php:144 +#: template/akasia-dz/biblio_list_template.php:147 +#: template/akasia/biblio_list_template.php:148 +#: template/lightweight/biblio_list_template.php:147 msgid "none copy available" msgstr "tidak ada kopi yang tersedia" -#: template/akasia-dz/biblio_list_template.php:146 -#: template/akasia/biblio_list_template.php:147 -#: template/lightweight/biblio_list_template.php:146 +#: template/akasia-dz/biblio_list_template.php:149 +#: template/akasia/biblio_list_template.php:150 +#: template/lightweight/biblio_list_template.php:149 msgid "{numberAvailable} copies available for loan" msgstr "{numberAvailable} koleksi tersedia untuk dipinjam" -#: template/akasia-dz/biblio_list_template.php:158 -#: template/akasia/biblio_list_template.php:159 -#: template/lightweight/biblio_list_template.php:158 +#: template/akasia-dz/biblio_list_template.php:161 +#: template/akasia/biblio_list_template.php:162 +#: template/lightweight/biblio_list_template.php:161 msgid "mark this" msgstr "tandai ini" -#: template/akasia-dz/biblio_list_template.php:167 -#: template/akasia/biblio_list_template.php:168 -#: template/lightweight/biblio_list_template.php:167 +#: template/akasia-dz/biblio_list_template.php:170 +#: template/akasia/biblio_list_template.php:171 +#: template/lightweight/biblio_list_template.php:170 msgid "Share this title to Facebook" msgstr "Bagikan ke Facebook" -#: template/akasia-dz/biblio_list_template.php:168 -#: template/akasia/biblio_list_template.php:169 -#: template/lightweight/biblio_list_template.php:168 +#: template/akasia-dz/biblio_list_template.php:171 +#: template/akasia/biblio_list_template.php:172 +#: template/lightweight/biblio_list_template.php:171 msgid "Share this title to Twitter" msgstr "Bagikan ke Twitter" -#: template/akasia-dz/biblio_list_template.php:169 -#: template/akasia/biblio_list_template.php:170 -#: template/lightweight/biblio_list_template.php:169 +#: template/akasia-dz/biblio_list_template.php:172 +#: template/akasia/biblio_list_template.php:173 +#: template/lightweight/biblio_list_template.php:172 msgid "Share this title to Google Plus" msgstr "Bagikan ke Google Plus" -#: template/akasia-dz/biblio_list_template.php:170 -#: template/akasia/biblio_list_template.php:171 -#: template/lightweight/biblio_list_template.php:170 +#: template/akasia-dz/biblio_list_template.php:173 +#: template/akasia/biblio_list_template.php:174 +#: template/lightweight/biblio_list_template.php:173 msgid "Share this title to Digg It" msgstr "Bagikan ke Digg It" -#: template/akasia-dz/biblio_list_template.php:171 -#: template/akasia/biblio_list_template.php:172 -#: template/lightweight/biblio_list_template.php:171 +#: template/akasia-dz/biblio_list_template.php:174 +#: template/akasia/biblio_list_template.php:175 +#: template/lightweight/biblio_list_template.php:174 msgid "Share this title to Reddit" msgstr "Bagikan ke Reddit" -#: template/akasia-dz/biblio_list_template.php:172 -#: template/akasia/biblio_list_template.php:173 -#: template/lightweight/biblio_list_template.php:172 +#: template/akasia-dz/biblio_list_template.php:175 +#: template/akasia/biblio_list_template.php:176 +#: template/lightweight/biblio_list_template.php:175 msgid "Share this title to LinkedIn" msgstr "Bagikan ke LinkedIn" -#: template/akasia-dz/biblio_list_template.php:173 -#: template/akasia/biblio_list_template.php:174 -#: template/lightweight/biblio_list_template.php:173 +#: template/akasia-dz/biblio_list_template.php:176 +#: template/akasia/biblio_list_template.php:177 +#: template/lightweight/biblio_list_template.php:176 msgid "Share this title to StumbleUpon" msgstr "Bagikan ke StumbleUpon" @@ -9033,7 +9179,7 @@ msgstr "Gaya Turabian" #: template/akasia-dz/detail_template.php:37 #: template/akasia/custom_frontpage_record.inc.php:11 #: template/akasia/detail_template.php:37 -#: template/default/biblio_list_template.php:110 +#: template/default/biblio_list_template.php:113 #: template/default/detail_template.php:31 #: template/lightweight/custom_frontpage_record.inc.php:11 #: template/lightweight/detail_template.php:37 @@ -9232,11 +9378,11 @@ msgstr "Informasi Lainnya" msgid "Advanced Search" msgstr "Pencarian Spesifik" -#: template/default/biblio_list_template.php:114 +#: template/default/biblio_list_template.php:117 msgid "Add to basket" msgstr "Tambahkan ke dalam keranjang" -#: template/default/biblio_list_template.php:119 +#: template/default/biblio_list_template.php:122 msgid "View Detail" msgstr "Tampilkan Detail" @@ -9550,6 +9696,168 @@ msgstr "Masuk" msgid "Put some keyword(s)..." msgstr "Masukkan kata kunci..." +#~ msgid "Send" +#~ msgstr "Kirim" + +#~ msgid "Telegram Account" +#~ msgstr "Akun Telegram" + +#~ msgid "Telegram Username" +#~ msgstr "Nama Pengguna Telegram" + +#~ msgid "Direct Message" +#~ msgstr "Pesan Langsung" + +#~ msgid "Write Message" +#~ msgstr "Tulis Pesan" + +#~ msgid "Question or Response can't be empty" +#~ msgstr "Pertanyaan atau Tanggapan tidak boleh dikosongkan" + +#~ msgid "Telegram Auto Response" +#~ msgstr "Tanggapan Automatis Telegram" + +#~ msgid "Question List" +#~ msgstr "Daftar Pertanyaan" + +#, fuzzy +#~| msgid "Add New Subscription" +#~ msgid "Add New Question" +#~ msgstr "Tambah Data Berlangganan" + +#, fuzzy +#~| msgid "Suggestion" +#~ msgid "Question" +#~ msgstr "Saran" + +#, fuzzy, php-format +#~| msgid "Welcome to our library." +#~ msgid "Welcome to %s library" +#~ msgstr "Selamat datang di perpustakaan kami." + +#, fuzzy +#~| msgid "My Account" +#~ msgid "Your Account :" +#~ msgstr "Akun Saya" + +#, fuzzy, php-format +#~| msgid "Member ID" +#~ msgid "Member ID : %s" +#~ msgstr "ID Anggota" + +#, fuzzy, php-format +#~| msgid "Member Name" +#~ msgid "Member Name : %s" +#~ msgstr "Nama Anggota" + +#, fuzzy +#~| msgid "Insert Item Code/Barcode" +#~ msgid "Insert Item Code" +#~ msgstr "Masukkan Kode Eksemplar/Barkod" + +#, fuzzy +#~| msgid "This Item is not registered in database" +#~ msgid "Item not registered in database" +#~ msgstr "Eksemplar ini tidak terdaftar dalam pangkalan data" + +#, fuzzy +#~| msgid "Transaction finished" +#~ msgid "Transaction Aborted" +#~ msgstr "Transaksi Selesai" + +#, fuzzy +#~| msgid "%s already reseved" +#~ msgid "Account already registered" +#~ msgstr "%s sudah dipesan" + +#, fuzzy +#~| msgid "Enter your member ID" +#~ msgid "Insert your username" +#~ msgstr "Masukkan ID anggota Anda" + +#, fuzzy +#~| msgid "Status" +#~ msgid "Status : " +#~ msgstr "Status" + +#, fuzzy +#~| msgid "Current Loans" +#~ msgid "Current Fines" +#~ msgstr "Pinjaman Saat Ini" + +#~ msgid "Debet" +#~ msgstr "Debit" + +#, fuzzy +#~| msgid "Title can not be empty" +#~ msgid "TOKEN and Bot Name can not be empty" +#~ msgstr "Judul tidak boleh kosong" + +#, fuzzy +#~| msgid "Shortcut Settings" +#~ msgid "Bot Settings" +#~ msgstr "Pengaturan Pemintas" + +#, fuzzy +#~| msgid "Modify UCS preferences" +#~ msgid "Modify telegram bot preferences" +#~ msgstr "Ubah Preferensi UCS" + +#, fuzzy +#~| msgid "Item Status" +#~ msgid "Bot Telegram Status" +#~ msgstr "Status Eksemplar" + +#, fuzzy +#~| msgid "Self Location" +#~ msgid "Self Activation" +#~ msgstr "Lokasi Rak" + +#, fuzzy +#~| msgid "Self Location" +#~ msgid "Self Loan Extension" +#~ msgstr "Lokasi Rak" + +#, fuzzy +#~| msgid "Self Location" +#~ msgid "Self Booking" +#~ msgstr "Lokasi Rak" + +#, fuzzy +#~| msgid "Print Circulation Receipt" +#~ msgid "Circulation Receipt" +#~ msgstr "Cetak Bukti Sirkulasi" + +#, fuzzy +#~| msgid "Send Notification e-mail" +#~ msgid "Visiting Notification" +#~ msgstr "Kirim surel Pemberitahuan" + +#, fuzzy +#~| msgid "Due Date Warning" +#~ msgid "Overdue Warning" +#~ msgstr "Peringatan Jatuh Tempo" + +#, fuzzy +#~| msgid "Overdue" +#~ msgid "Overdue Notice" +#~ msgstr "Keterlambatan" + +#, fuzzy +#~| msgid "Location Name" +#~ msgid "Bot Name" +#~ msgstr "Nama Lokasi" + +#, fuzzy +#~| msgid "Collections" +#~ msgid "Max Connections" +#~ msgstr "Koleksi" + +#, fuzzy +#~| msgid "Author added!" +#~ msgid "Bot Authorized!" +#~ msgstr "Pengarang berhasil ditambahkan!" + #~ msgid "SYSTEM CONFIG" #~ msgstr "KONFIGURASI SISTEM" @@ -9608,11 +9916,6 @@ msgstr "Masukkan kata kunci..." #~ msgid "Add to print queue" #~ msgstr "Tambahkan dalam antrian cetak?" -#, fuzzy -#~| msgid "UCS Configuration" -#~ msgid "Global Configuration" -#~ msgstr "Pengaturan UCS" - #~ msgid "Fonts" #~ msgstr "Fonta" @@ -9873,9 +10176,6 @@ msgstr "Masukkan kata kunci..." #~ msgid "{recordCount} records inserted to database." #~ msgstr "{recordCount} data berhasil disimpan ke dalam basisdata." -#~ msgid "Debet" -#~ msgstr "Debit" - #~ msgid "Goto backup tools" #~ msgstr "Buat Cadangan Pangkalan Data" diff --git a/lib/module.inc.php b/lib/module.inc.php index a73cede8..3e7a01ad 100755 --- a/lib/module.inc.php +++ b/lib/module.inc.php @@ -131,7 +131,7 @@ public function generateSubMenu($str_module = '') $header_index = 0; foreach ($menu as $_list) { if ($_list[0] == 'Header') { - $_submenu .= '
' . $_list[1] . '
'; + $_submenu .= '
' . $_list[1] . '
'; $header_index++; } else { if ($i > 1) $_submenu_current = ''; @@ -162,23 +162,36 @@ public function getSubMenuItems($str_module = '') if (file_exists($_submenu_file)) { include $_submenu_file; - $menu = array_merge($menu ?? [], $plugin_menus); - - if ($_SESSION['uid'] > 1) { - $tmp_menu = []; - if (isset($menu) && count($menu) > 0) { - foreach ($menu as $item) { - if ($item[0] === 'Header' || in_array(md5($item[1]), $_SESSION['priv'][$str_module]['menus'])) $tmp_menu[] = $item; - } + // grouping menu from sub_menu.php + $menu_grouped = []; + $header_name = null; + foreach ($menu ?? [] as $menu_item) { + if (strtolower($menu_item[0]) === 'header') { + $header_name = strtolower($menu_item[1]); + $menu_grouped[$header_name] = $menu_grouped[$header_name] ?? []; + continue; } - $menu = $tmp_menu; + if ($_SESSION['uid'] > 1 && !in_array(md5($menu_item[1]), $_SESSION['priv'][$str_module]['menus'] ?? [])) continue; + $menu_grouped[$header_name][] = $menu_item; } - // clean header, remove it if not have child - foreach ($menu as $index => $item) - if ($item[0] === 'Header' && (!isset($menu[$index + 1]) || (isset($menu[$index + 1]) && $menu[$index + 1][0] === 'Header'))) - unset($menu[$index]); + foreach ($plugin_menus as $key => $plugin_menu) { + if ($_SESSION['uid'] > 1 && !in_array(md5($plugin_menu[1]), $_SESSION['priv'][$str_module]['menus'] ?? [])) continue; + $group_name = \SLiMS\GroupMenu::getInstance()->getGroupName($key); + if (!is_null($group_name)) { + $menu_grouped[$group_name][] = $plugin_menu; + continue; + } + $menu_grouped['plugins'][] = $plugin_menu; + } + // ungroup menus + $menu = []; + foreach ($menu_grouped as $header => $item) { + if (empty($item)) continue; + $menu[] = ['Header', strtoupper($header)]; + $menu = array_merge($menu, $item); + } } else { include 'default/submenu.php'; foreach ($this->get_shortcuts_menu($dbs) as $key => $value) { diff --git a/lib/oaipmh/oaidp-config.php b/lib/oaipmh/oaidp-config.php index de1dcbaa..700c7ffe 100644 --- a/lib/oaipmh/oaidp-config.php +++ b/lib/oaipmh/oaidp-config.php @@ -237,6 +237,7 @@ // change according to your local DB setup. $DB_HOST = DB_HOST; +$DB_PORT = DB_PORT; $DB_USER = DB_USERNAME; $DB_PASSWD = DB_PASSWORD; $DB_NAME = DB_NAME; @@ -245,7 +246,7 @@ // if you use something other than mysql edit accordingly. // Example for MySQL //$DSN = "mysql://$DB_USER:$DB_PASSWD@$DB_HOST/$DB_NAME"; -$DSN = "mysql:host=$DB_HOST;dbname=$DB_NAME"; +$DSN = "mysql:host=$DB_HOST;port=$DB_PORT;dbname=$DB_NAME"; // Example for Oracle // $DSN = "oci8://$DB_USER:$DB_PASSWD@$DB_NAME"; diff --git a/lib/psr/http-client/CHANGELOG.md b/lib/psr/http-client/CHANGELOG.md new file mode 100644 index 00000000..e2dc25f5 --- /dev/null +++ b/lib/psr/http-client/CHANGELOG.md @@ -0,0 +1,23 @@ +# Changelog + +All notable changes to this project will be documented in this file, in reverse chronological order by release. + +## 1.0.1 + +Allow installation with PHP 8. No code changes. + +## 1.0.0 + +First stable release. No changes since 0.3.0. + +## 0.3.0 + +Added Interface suffix on exceptions + +## 0.2.0 + +All exceptions are in `Psr\Http\Client` namespace + +## 0.1.0 + +First release diff --git a/lib/psr/http-client/LICENSE b/lib/psr/http-client/LICENSE new file mode 100644 index 00000000..cd5e0020 --- /dev/null +++ b/lib/psr/http-client/LICENSE @@ -0,0 +1,19 @@ +Copyright (c) 2017 PHP Framework Interoperability Group + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/lib/psr/http-client/README.md b/lib/psr/http-client/README.md new file mode 100644 index 00000000..6876b840 --- /dev/null +++ b/lib/psr/http-client/README.md @@ -0,0 +1,12 @@ +HTTP Client +=========== + +This repository holds all the common code related to [PSR-18 (HTTP Client)][psr-url]. + +Note that this is not a HTTP Client implementation of its own. It is merely abstractions that describe the components of a HTTP Client. + +The installable [package][package-url] and [implementations][implementation-url] are listed on Packagist. + +[psr-url]: http://www.php-fig.org/psr/psr-18 +[package-url]: https://packagist.org/packages/psr/http-client +[implementation-url]: https://packagist.org/providers/psr/http-client-implementation diff --git a/lib/psr/http-client/composer.json b/lib/psr/http-client/composer.json new file mode 100644 index 00000000..c195f8ff --- /dev/null +++ b/lib/psr/http-client/composer.json @@ -0,0 +1,27 @@ +{ + "name": "psr/http-client", + "description": "Common interface for HTTP clients", + "keywords": ["psr", "psr-18", "http", "http-client"], + "homepage": "https://github.com/php-fig/http-client", + "license": "MIT", + "authors": [ + { + "name": "PHP-FIG", + "homepage": "http://www.php-fig.org/" + } + ], + "require": { + "php": "^7.0 || ^8.0", + "psr/http-message": "^1.0" + }, + "autoload": { + "psr-4": { + "Psr\\Http\\Client\\": "src/" + } + }, + "extra": { + "branch-alias": { + "dev-master": "1.0.x-dev" + } + } +} diff --git a/lib/psr/http-client/src/ClientExceptionInterface.php b/lib/psr/http-client/src/ClientExceptionInterface.php new file mode 100644 index 00000000..aa0b9cf1 --- /dev/null +++ b/lib/psr/http-client/src/ClientExceptionInterface.php @@ -0,0 +1,10 @@ +=7.0.0", + "psr/http-message": "^1.0" + }, + "autoload": { + "psr-4": { + "Psr\\Http\\Message\\": "src/" + } + }, + "extra": { + "branch-alias": { + "dev-master": "1.0.x-dev" + } + } +} diff --git a/lib/psr/http-factory/src/RequestFactoryInterface.php b/lib/psr/http-factory/src/RequestFactoryInterface.php new file mode 100644 index 00000000..cb39a08b --- /dev/null +++ b/lib/psr/http-factory/src/RequestFactoryInterface.php @@ -0,0 +1,18 @@ +=5.3.0" + }, + "autoload": { + "psr-4": { + "Psr\\Http\\Message\\": "src/" + } + }, + "extra": { + "branch-alias": { + "dev-master": "1.0.x-dev" + } + } +} diff --git a/lib/psr/http-message/src/MessageInterface.php b/lib/psr/http-message/src/MessageInterface.php new file mode 100644 index 00000000..dd46e5ec --- /dev/null +++ b/lib/psr/http-message/src/MessageInterface.php @@ -0,0 +1,187 @@ +getHeaders() as $name => $values) { + * echo $name . ": " . implode(", ", $values); + * } + * + * // Emit headers iteratively: + * foreach ($message->getHeaders() as $name => $values) { + * foreach ($values as $value) { + * header(sprintf('%s: %s', $name, $value), false); + * } + * } + * + * While header names are not case-sensitive, getHeaders() will preserve the + * exact case in which headers were originally specified. + * + * @return string[][] Returns an associative array of the message's headers. Each + * key MUST be a header name, and each value MUST be an array of strings + * for that header. + */ + public function getHeaders(); + + /** + * Checks if a header exists by the given case-insensitive name. + * + * @param string $name Case-insensitive header field name. + * @return bool Returns true if any header names match the given header + * name using a case-insensitive string comparison. Returns false if + * no matching header name is found in the message. + */ + public function hasHeader($name); + + /** + * Retrieves a message header value by the given case-insensitive name. + * + * This method returns an array of all the header values of the given + * case-insensitive header name. + * + * If the header does not appear in the message, this method MUST return an + * empty array. + * + * @param string $name Case-insensitive header field name. + * @return string[] An array of string values as provided for the given + * header. If the header does not appear in the message, this method MUST + * return an empty array. + */ + public function getHeader($name); + + /** + * Retrieves a comma-separated string of the values for a single header. + * + * This method returns all of the header values of the given + * case-insensitive header name as a string concatenated together using + * a comma. + * + * NOTE: Not all header values may be appropriately represented using + * comma concatenation. For such headers, use getHeader() instead + * and supply your own delimiter when concatenating. + * + * If the header does not appear in the message, this method MUST return + * an empty string. + * + * @param string $name Case-insensitive header field name. + * @return string A string of values as provided for the given header + * concatenated together using a comma. If the header does not appear in + * the message, this method MUST return an empty string. + */ + public function getHeaderLine($name); + + /** + * Return an instance with the provided value replacing the specified header. + * + * While header names are case-insensitive, the casing of the header will + * be preserved by this function, and returned from getHeaders(). + * + * This method MUST be implemented in such a way as to retain the + * immutability of the message, and MUST return an instance that has the + * new and/or updated header and value. + * + * @param string $name Case-insensitive header field name. + * @param string|string[] $value Header value(s). + * @return static + * @throws \InvalidArgumentException for invalid header names or values. + */ + public function withHeader($name, $value); + + /** + * Return an instance with the specified header appended with the given value. + * + * Existing values for the specified header will be maintained. The new + * value(s) will be appended to the existing list. If the header did not + * exist previously, it will be added. + * + * This method MUST be implemented in such a way as to retain the + * immutability of the message, and MUST return an instance that has the + * new header and/or value. + * + * @param string $name Case-insensitive header field name to add. + * @param string|string[] $value Header value(s). + * @return static + * @throws \InvalidArgumentException for invalid header names or values. + */ + public function withAddedHeader($name, $value); + + /** + * Return an instance without the specified header. + * + * Header resolution MUST be done without case-sensitivity. + * + * This method MUST be implemented in such a way as to retain the + * immutability of the message, and MUST return an instance that removes + * the named header. + * + * @param string $name Case-insensitive header field name to remove. + * @return static + */ + public function withoutHeader($name); + + /** + * Gets the body of the message. + * + * @return StreamInterface Returns the body as a stream. + */ + public function getBody(); + + /** + * Return an instance with the specified message body. + * + * The body MUST be a StreamInterface object. + * + * This method MUST be implemented in such a way as to retain the + * immutability of the message, and MUST return a new instance that has the + * new body stream. + * + * @param StreamInterface $body Body. + * @return static + * @throws \InvalidArgumentException When the body is not valid. + */ + public function withBody(StreamInterface $body); +} diff --git a/lib/psr/http-message/src/RequestInterface.php b/lib/psr/http-message/src/RequestInterface.php new file mode 100644 index 00000000..a96d4fd6 --- /dev/null +++ b/lib/psr/http-message/src/RequestInterface.php @@ -0,0 +1,129 @@ +getQuery()` + * or from the `QUERY_STRING` server param. + * + * @return array + */ + public function getQueryParams(); + + /** + * Return an instance with the specified query string arguments. + * + * These values SHOULD remain immutable over the course of the incoming + * request. They MAY be injected during instantiation, such as from PHP's + * $_GET superglobal, or MAY be derived from some other value such as the + * URI. In cases where the arguments are parsed from the URI, the data + * MUST be compatible with what PHP's parse_str() would return for + * purposes of how duplicate query parameters are handled, and how nested + * sets are handled. + * + * Setting query string arguments MUST NOT change the URI stored by the + * request, nor the values in the server params. + * + * This method MUST be implemented in such a way as to retain the + * immutability of the message, and MUST return an instance that has the + * updated query string arguments. + * + * @param array $query Array of query string arguments, typically from + * $_GET. + * @return static + */ + public function withQueryParams(array $query); + + /** + * Retrieve normalized file upload data. + * + * This method returns upload metadata in a normalized tree, with each leaf + * an instance of Psr\Http\Message\UploadedFileInterface. + * + * These values MAY be prepared from $_FILES or the message body during + * instantiation, or MAY be injected via withUploadedFiles(). + * + * @return array An array tree of UploadedFileInterface instances; an empty + * array MUST be returned if no data is present. + */ + public function getUploadedFiles(); + + /** + * Create a new instance with the specified uploaded files. + * + * This method MUST be implemented in such a way as to retain the + * immutability of the message, and MUST return an instance that has the + * updated body parameters. + * + * @param array $uploadedFiles An array tree of UploadedFileInterface instances. + * @return static + * @throws \InvalidArgumentException if an invalid structure is provided. + */ + public function withUploadedFiles(array $uploadedFiles); + + /** + * Retrieve any parameters provided in the request body. + * + * If the request Content-Type is either application/x-www-form-urlencoded + * or multipart/form-data, and the request method is POST, this method MUST + * return the contents of $_POST. + * + * Otherwise, this method may return any results of deserializing + * the request body content; as parsing returns structured content, the + * potential types MUST be arrays or objects only. A null value indicates + * the absence of body content. + * + * @return null|array|object The deserialized body parameters, if any. + * These will typically be an array or object. + */ + public function getParsedBody(); + + /** + * Return an instance with the specified body parameters. + * + * These MAY be injected during instantiation. + * + * If the request Content-Type is either application/x-www-form-urlencoded + * or multipart/form-data, and the request method is POST, use this method + * ONLY to inject the contents of $_POST. + * + * The data IS NOT REQUIRED to come from $_POST, but MUST be the results of + * deserializing the request body content. Deserialization/parsing returns + * structured data, and, as such, this method ONLY accepts arrays or objects, + * or a null value if nothing was available to parse. + * + * As an example, if content negotiation determines that the request data + * is a JSON payload, this method could be used to create a request + * instance with the deserialized parameters. + * + * This method MUST be implemented in such a way as to retain the + * immutability of the message, and MUST return an instance that has the + * updated body parameters. + * + * @param null|array|object $data The deserialized body data. This will + * typically be in an array or object. + * @return static + * @throws \InvalidArgumentException if an unsupported argument type is + * provided. + */ + public function withParsedBody($data); + + /** + * Retrieve attributes derived from the request. + * + * The request "attributes" may be used to allow injection of any + * parameters derived from the request: e.g., the results of path + * match operations; the results of decrypting cookies; the results of + * deserializing non-form-encoded message bodies; etc. Attributes + * will be application and request specific, and CAN be mutable. + * + * @return array Attributes derived from the request. + */ + public function getAttributes(); + + /** + * Retrieve a single derived request attribute. + * + * Retrieves a single derived request attribute as described in + * getAttributes(). If the attribute has not been previously set, returns + * the default value as provided. + * + * This method obviates the need for a hasAttribute() method, as it allows + * specifying a default value to return if the attribute is not found. + * + * @see getAttributes() + * @param string $name The attribute name. + * @param mixed $default Default value to return if the attribute does not exist. + * @return mixed + */ + public function getAttribute($name, $default = null); + + /** + * Return an instance with the specified derived request attribute. + * + * This method allows setting a single derived request attribute as + * described in getAttributes(). + * + * This method MUST be implemented in such a way as to retain the + * immutability of the message, and MUST return an instance that has the + * updated attribute. + * + * @see getAttributes() + * @param string $name The attribute name. + * @param mixed $value The value of the attribute. + * @return static + */ + public function withAttribute($name, $value); + + /** + * Return an instance that removes the specified derived request attribute. + * + * This method allows removing a single derived request attribute as + * described in getAttributes(). + * + * This method MUST be implemented in such a way as to retain the + * immutability of the message, and MUST return an instance that removes + * the attribute. + * + * @see getAttributes() + * @param string $name The attribute name. + * @return static + */ + public function withoutAttribute($name); +} diff --git a/lib/psr/http-message/src/StreamInterface.php b/lib/psr/http-message/src/StreamInterface.php new file mode 100644 index 00000000..f68f3912 --- /dev/null +++ b/lib/psr/http-message/src/StreamInterface.php @@ -0,0 +1,158 @@ + + * [user-info@]host[:port] + * + * + * If the port component is not set or is the standard port for the current + * scheme, it SHOULD NOT be included. + * + * @see https://tools.ietf.org/html/rfc3986#section-3.2 + * @return string The URI authority, in "[user-info@]host[:port]" format. + */ + public function getAuthority(); + + /** + * Retrieve the user information component of the URI. + * + * If no user information is present, this method MUST return an empty + * string. + * + * If a user is present in the URI, this will return that value; + * additionally, if the password is also present, it will be appended to the + * user value, with a colon (":") separating the values. + * + * The trailing "@" character is not part of the user information and MUST + * NOT be added. + * + * @return string The URI user information, in "username[:password]" format. + */ + public function getUserInfo(); + + /** + * Retrieve the host component of the URI. + * + * If no host is present, this method MUST return an empty string. + * + * The value returned MUST be normalized to lowercase, per RFC 3986 + * Section 3.2.2. + * + * @see http://tools.ietf.org/html/rfc3986#section-3.2.2 + * @return string The URI host. + */ + public function getHost(); + + /** + * Retrieve the port component of the URI. + * + * If a port is present, and it is non-standard for the current scheme, + * this method MUST return it as an integer. If the port is the standard port + * used with the current scheme, this method SHOULD return null. + * + * If no port is present, and no scheme is present, this method MUST return + * a null value. + * + * If no port is present, but a scheme is present, this method MAY return + * the standard port for that scheme, but SHOULD return null. + * + * @return null|int The URI port. + */ + public function getPort(); + + /** + * Retrieve the path component of the URI. + * + * The path can either be empty or absolute (starting with a slash) or + * rootless (not starting with a slash). Implementations MUST support all + * three syntaxes. + * + * Normally, the empty path "" and absolute path "/" are considered equal as + * defined in RFC 7230 Section 2.7.3. But this method MUST NOT automatically + * do this normalization because in contexts with a trimmed base path, e.g. + * the front controller, this difference becomes significant. It's the task + * of the user to handle both "" and "/". + * + * The value returned MUST be percent-encoded, but MUST NOT double-encode + * any characters. To determine what characters to encode, please refer to + * RFC 3986, Sections 2 and 3.3. + * + * As an example, if the value should include a slash ("/") not intended as + * delimiter between path segments, that value MUST be passed in encoded + * form (e.g., "%2F") to the instance. + * + * @see https://tools.ietf.org/html/rfc3986#section-2 + * @see https://tools.ietf.org/html/rfc3986#section-3.3 + * @return string The URI path. + */ + public function getPath(); + + /** + * Retrieve the query string of the URI. + * + * If no query string is present, this method MUST return an empty string. + * + * The leading "?" character is not part of the query and MUST NOT be + * added. + * + * The value returned MUST be percent-encoded, but MUST NOT double-encode + * any characters. To determine what characters to encode, please refer to + * RFC 3986, Sections 2 and 3.4. + * + * As an example, if a value in a key/value pair of the query string should + * include an ampersand ("&") not intended as a delimiter between values, + * that value MUST be passed in encoded form (e.g., "%26") to the instance. + * + * @see https://tools.ietf.org/html/rfc3986#section-2 + * @see https://tools.ietf.org/html/rfc3986#section-3.4 + * @return string The URI query string. + */ + public function getQuery(); + + /** + * Retrieve the fragment component of the URI. + * + * If no fragment is present, this method MUST return an empty string. + * + * The leading "#" character is not part of the fragment and MUST NOT be + * added. + * + * The value returned MUST be percent-encoded, but MUST NOT double-encode + * any characters. To determine what characters to encode, please refer to + * RFC 3986, Sections 2 and 3.5. + * + * @see https://tools.ietf.org/html/rfc3986#section-2 + * @see https://tools.ietf.org/html/rfc3986#section-3.5 + * @return string The URI fragment. + */ + public function getFragment(); + + /** + * Return an instance with the specified scheme. + * + * This method MUST retain the state of the current instance, and return + * an instance that contains the specified scheme. + * + * Implementations MUST support the schemes "http" and "https" case + * insensitively, and MAY accommodate other schemes if required. + * + * An empty scheme is equivalent to removing the scheme. + * + * @param string $scheme The scheme to use with the new instance. + * @return static A new instance with the specified scheme. + * @throws \InvalidArgumentException for invalid or unsupported schemes. + */ + public function withScheme($scheme); + + /** + * Return an instance with the specified user information. + * + * This method MUST retain the state of the current instance, and return + * an instance that contains the specified user information. + * + * Password is optional, but the user information MUST include the + * user; an empty string for the user is equivalent to removing user + * information. + * + * @param string $user The user name to use for authority. + * @param null|string $password The password associated with $user. + * @return static A new instance with the specified user information. + */ + public function withUserInfo($user, $password = null); + + /** + * Return an instance with the specified host. + * + * This method MUST retain the state of the current instance, and return + * an instance that contains the specified host. + * + * An empty host value is equivalent to removing the host. + * + * @param string $host The hostname to use with the new instance. + * @return static A new instance with the specified host. + * @throws \InvalidArgumentException for invalid hostnames. + */ + public function withHost($host); + + /** + * Return an instance with the specified port. + * + * This method MUST retain the state of the current instance, and return + * an instance that contains the specified port. + * + * Implementations MUST raise an exception for ports outside the + * established TCP and UDP port ranges. + * + * A null value provided for the port is equivalent to removing the port + * information. + * + * @param null|int $port The port to use with the new instance; a null value + * removes the port information. + * @return static A new instance with the specified port. + * @throws \InvalidArgumentException for invalid ports. + */ + public function withPort($port); + + /** + * Return an instance with the specified path. + * + * This method MUST retain the state of the current instance, and return + * an instance that contains the specified path. + * + * The path can either be empty or absolute (starting with a slash) or + * rootless (not starting with a slash). Implementations MUST support all + * three syntaxes. + * + * If the path is intended to be domain-relative rather than path relative then + * it must begin with a slash ("/"). Paths not starting with a slash ("/") + * are assumed to be relative to some base path known to the application or + * consumer. + * + * Users can provide both encoded and decoded path characters. + * Implementations ensure the correct encoding as outlined in getPath(). + * + * @param string $path The path to use with the new instance. + * @return static A new instance with the specified path. + * @throws \InvalidArgumentException for invalid paths. + */ + public function withPath($path); + + /** + * Return an instance with the specified query string. + * + * This method MUST retain the state of the current instance, and return + * an instance that contains the specified query string. + * + * Users can provide both encoded and decoded query characters. + * Implementations ensure the correct encoding as outlined in getQuery(). + * + * An empty query string value is equivalent to removing the query string. + * + * @param string $query The query string to use with the new instance. + * @return static A new instance with the specified query string. + * @throws \InvalidArgumentException for invalid query strings. + */ + public function withQuery($query); + + /** + * Return an instance with the specified URI fragment. + * + * This method MUST retain the state of the current instance, and return + * an instance that contains the specified URI fragment. + * + * Users can provide both encoded and decoded fragment characters. + * Implementations ensure the correct encoding as outlined in getFragment(). + * + * An empty fragment value is equivalent to removing the fragment. + * + * @param string $fragment The fragment to use with the new instance. + * @return static A new instance with the specified fragment. + */ + public function withFragment($fragment); + + /** + * Return the string representation as a URI reference. + * + * Depending on which components of the URI are present, the resulting + * string is either a full URI or relative reference according to RFC 3986, + * Section 4.1. The method concatenates the various components of the URI, + * using the appropriate delimiters: + * + * - If a scheme is present, it MUST be suffixed by ":". + * - If an authority is present, it MUST be prefixed by "//". + * - The path can be concatenated without delimiters. But there are two + * cases where the path has to be adjusted to make the URI reference + * valid as PHP does not allow to throw an exception in __toString(): + * - If the path is rootless and an authority is present, the path MUST + * be prefixed by "/". + * - If the path is starting with more than one "/" and no authority is + * present, the starting slashes MUST be reduced to one. + * - If a query is present, it MUST be prefixed by "?". + * - If a fragment is present, it MUST be prefixed by "#". + * + * @see http://tools.ietf.org/html/rfc3986#section-4.1 + * @return string + */ + public function __toString(); +} diff --git a/lib/ralouphie/getallheaders/LICENSE b/lib/ralouphie/getallheaders/LICENSE new file mode 100644 index 00000000..be5540c2 --- /dev/null +++ b/lib/ralouphie/getallheaders/LICENSE @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2014 Ralph Khattar + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/lib/ralouphie/getallheaders/README.md b/lib/ralouphie/getallheaders/README.md new file mode 100644 index 00000000..9430d76b --- /dev/null +++ b/lib/ralouphie/getallheaders/README.md @@ -0,0 +1,27 @@ +getallheaders +============= + +PHP `getallheaders()` polyfill. Compatible with PHP >= 5.3. + +[![Build Status](https://travis-ci.org/ralouphie/getallheaders.svg?branch=master)](https://travis-ci.org/ralouphie/getallheaders) +[![Coverage Status](https://coveralls.io/repos/ralouphie/getallheaders/badge.png?branch=master)](https://coveralls.io/r/ralouphie/getallheaders?branch=master) +[![Latest Stable Version](https://poser.pugx.org/ralouphie/getallheaders/v/stable.png)](https://packagist.org/packages/ralouphie/getallheaders) +[![Latest Unstable Version](https://poser.pugx.org/ralouphie/getallheaders/v/unstable.png)](https://packagist.org/packages/ralouphie/getallheaders) +[![License](https://poser.pugx.org/ralouphie/getallheaders/license.png)](https://packagist.org/packages/ralouphie/getallheaders) + + +This is a simple polyfill for [`getallheaders()`](http://www.php.net/manual/en/function.getallheaders.php). + +## Install + +For PHP version **`>= 5.6`**: + +``` +composer require ralouphie/getallheaders +``` + +For PHP version **`< 5.6`**: + +``` +composer require ralouphie/getallheaders "^2" +``` diff --git a/lib/ralouphie/getallheaders/composer.json b/lib/ralouphie/getallheaders/composer.json new file mode 100644 index 00000000..de8ce62e --- /dev/null +++ b/lib/ralouphie/getallheaders/composer.json @@ -0,0 +1,26 @@ +{ + "name": "ralouphie/getallheaders", + "description": "A polyfill for getallheaders.", + "license": "MIT", + "authors": [ + { + "name": "Ralph Khattar", + "email": "ralph.khattar@gmail.com" + } + ], + "require": { + "php": ">=5.6" + }, + "require-dev": { + "phpunit/phpunit": "^5 || ^6.5", + "php-coveralls/php-coveralls": "^2.1" + }, + "autoload": { + "files": ["src/getallheaders.php"] + }, + "autoload-dev": { + "psr-4": { + "getallheaders\\Tests\\": "tests/" + } + } +} diff --git a/lib/ralouphie/getallheaders/src/getallheaders.php b/lib/ralouphie/getallheaders/src/getallheaders.php new file mode 100644 index 00000000..c7285a5b --- /dev/null +++ b/lib/ralouphie/getallheaders/src/getallheaders.php @@ -0,0 +1,46 @@ + 'Content-Type', + 'CONTENT_LENGTH' => 'Content-Length', + 'CONTENT_MD5' => 'Content-Md5', + ); + + foreach ($_SERVER as $key => $value) { + if (substr($key, 0, 5) === 'HTTP_') { + $key = substr($key, 5); + if (!isset($copy_server[$key]) || !isset($_SERVER[$key])) { + $key = str_replace(' ', '-', ucwords(strtolower(str_replace('_', ' ', $key)))); + $headers[$key] = $value; + } + } elseif (isset($copy_server[$key])) { + $headers[$copy_server[$key]] = $value; + } + } + + if (!isset($headers['Authorization'])) { + if (isset($_SERVER['REDIRECT_HTTP_AUTHORIZATION'])) { + $headers['Authorization'] = $_SERVER['REDIRECT_HTTP_AUTHORIZATION']; + } elseif (isset($_SERVER['PHP_AUTH_USER'])) { + $basic_pass = isset($_SERVER['PHP_AUTH_PW']) ? $_SERVER['PHP_AUTH_PW'] : ''; + $headers['Authorization'] = 'Basic ' . base64_encode($_SERVER['PHP_AUTH_USER'] . ':' . $basic_pass); + } elseif (isset($_SERVER['PHP_AUTH_DIGEST'])) { + $headers['Authorization'] = $_SERVER['PHP_AUTH_DIGEST']; + } + } + + return $headers; + } + +} diff --git a/lib/symfony/deprecation-contracts/.gitignore b/lib/symfony/deprecation-contracts/.gitignore new file mode 100644 index 00000000..c49a5d8d --- /dev/null +++ b/lib/symfony/deprecation-contracts/.gitignore @@ -0,0 +1,3 @@ +vendor/ +composer.lock +phpunit.xml diff --git a/lib/symfony/deprecation-contracts/CHANGELOG.md b/lib/symfony/deprecation-contracts/CHANGELOG.md new file mode 100644 index 00000000..7932e261 --- /dev/null +++ b/lib/symfony/deprecation-contracts/CHANGELOG.md @@ -0,0 +1,5 @@ +CHANGELOG +========= + +The changelog is maintained for all Symfony contracts at the following URL: +https://github.com/symfony/contracts/blob/main/CHANGELOG.md diff --git a/lib/symfony/deprecation-contracts/LICENSE b/lib/symfony/deprecation-contracts/LICENSE new file mode 100644 index 00000000..ad85e173 --- /dev/null +++ b/lib/symfony/deprecation-contracts/LICENSE @@ -0,0 +1,19 @@ +Copyright (c) 2020-2021 Fabien Potencier + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is furnished +to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/lib/symfony/deprecation-contracts/README.md b/lib/symfony/deprecation-contracts/README.md new file mode 100644 index 00000000..4957933a --- /dev/null +++ b/lib/symfony/deprecation-contracts/README.md @@ -0,0 +1,26 @@ +Symfony Deprecation Contracts +============================= + +A generic function and convention to trigger deprecation notices. + +This package provides a single global function named `trigger_deprecation()` that triggers silenced deprecation notices. + +By using a custom PHP error handler such as the one provided by the Symfony ErrorHandler component, +the triggered deprecations can be caught and logged for later discovery, both on dev and prod environments. + +The function requires at least 3 arguments: + - the name of the Composer package that is triggering the deprecation + - the version of the package that introduced the deprecation + - the message of the deprecation + - more arguments can be provided: they will be inserted in the message using `printf()` formatting + +Example: +```php +trigger_deprecation('symfony/blockchain', '8.9', 'Using "%s" is deprecated, use "%s" instead.', 'bitcoin', 'fabcoin'); +``` + +This will generate the following message: +`Since symfony/blockchain 8.9: Using "bitcoin" is deprecated, use "fabcoin" instead.` + +While not necessarily recommended, the deprecation notices can be completely ignored by declaring an empty +`function trigger_deprecation() {}` in your application. diff --git a/lib/symfony/deprecation-contracts/composer.json b/lib/symfony/deprecation-contracts/composer.json new file mode 100644 index 00000000..38848896 --- /dev/null +++ b/lib/symfony/deprecation-contracts/composer.json @@ -0,0 +1,35 @@ +{ + "name": "symfony/deprecation-contracts", + "type": "library", + "description": "A generic function and convention to trigger deprecation notices", + "homepage": "https://symfony.com", + "license": "MIT", + "authors": [ + { + "name": "Nicolas Grekas", + "email": "p@tchwork.com" + }, + { + "name": "Symfony Community", + "homepage": "https://symfony.com/contributors" + } + ], + "require": { + "php": ">=7.1" + }, + "autoload": { + "files": [ + "function.php" + ] + }, + "minimum-stability": "dev", + "extra": { + "branch-alias": { + "dev-main": "2.4-dev" + }, + "thanks": { + "name": "symfony/contracts", + "url": "https://github.com/symfony/contracts" + } + } +} diff --git a/lib/symfony/deprecation-contracts/function.php b/lib/symfony/deprecation-contracts/function.php new file mode 100644 index 00000000..d4371504 --- /dev/null +++ b/lib/symfony/deprecation-contracts/function.php @@ -0,0 +1,27 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +if (!function_exists('trigger_deprecation')) { + /** + * Triggers a silenced deprecation notice. + * + * @param string $package The name of the Composer package that is triggering the deprecation + * @param string $version The version of the package that introduced the deprecation + * @param string $message The message of the deprecation + * @param mixed ...$args Values to insert in the message using printf() formatting + * + * @author Nicolas Grekas + */ + function trigger_deprecation(string $package, string $version, string $message, ...$args): void + { + @trigger_error(($package || $version ? "Since $package $version: " : '').($args ? vsprintf($message, $args) : $message), \E_USER_DEPRECATED); + } +} diff --git a/lib/utility.inc.php b/lib/utility.inc.php index 84f35a7c..58ca5346 100755 --- a/lib/utility.inc.php +++ b/lib/utility.inc.php @@ -1,667 +1,670 @@ -'."\n"; - echo 'alert("'.$str_message.'")'."\n"; - echo ''."\n"; - } - - /** - * Static Method to send out toastr notification - * - * @param string $type [info, success, warning, error] - * @param string $str_message - * @return void - */ - public static function jsToastr($title, $str_message, $type = 'info') - { - if (!$str_message) { - return; - } - - $options = [ - 'closeButton' => true, - 'debug' => false, - 'newestOnTop' => false, - 'progressBar' => false, - 'positionClass' => 'toast-top-right', - 'preventDuplicates' => false, - 'onclick' => null, - 'showDuration' => 300, - 'hideDuration' => 1000, - 'timeOut' => 5000, - 'extendedTimeOut' => 1000, - 'showEasing' => 'swing', - 'hideEasing' => 'linear', - 'showMethod' => 'fadeIn', - 'hideMethod' => 'fadeOut' - ]; - - // replace newline with javascripts newline - $str_message = str_replace("\n", '\n', addslashes($str_message)); - echo ''."\n"; - } - - - /** - * Static Method to create random string - * - * @param int $int_num_string: number of randowm string to created - * @return void - */ - public static function createRandomString($int_num_string = 32) - { - $_random = ''; - $_salt = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'; - $_saltlength = strlen($_salt); - for ($r = 0; $r < $int_num_string; $r++) { - $_random .= $_salt[rand(0, $_saltlength - 1)]; - } - - return $_random; - } - - - /** - * Static Method to load application settings from database - * - * @param object $obj_db - * @return void - */ - public static function loadSettings($obj_db) - { - global $sysconf; - $_setting_query = $obj_db->query('SELECT * FROM setting'); - if (!$obj_db->errno) { - while ($_setting_data = $_setting_query->fetch_assoc()) { - $_value = @unserialize($_setting_data['setting_value']); - if (is_array($_value)) { - foreach ($_value as $_idx=>$_curr_value) { - if (is_array($_curr_value)) { - $sysconf[$_setting_data['setting_name']][$_idx] = $_curr_value; - } else { - $sysconf[$_setting_data['setting_name']][$_idx] = stripslashes($_curr_value); - } - } - } else { - $sysconf[$_setting_data['setting_name']] = stripslashes($_value); - } - } - } - } - - - /** - * Static Method to check privileges of application module form current user - * - * @param string $str_module_name - * @param string $str_privilege_type - * @return boolean - */ - public static function havePrivilege($str_module_name, $str_privilege_type = 'r') - { - global $sysconf; - // checking checksum - if ($sysconf['load_balanced_env']) { - $server_addr = $_SERVER['REMOTE_ADDR']; - } else { - $server_addr = isset($_SERVER['SERVER_ADDR']) ? $_SERVER['SERVER_ADDR'] : (isset($_SERVER['LOCAL_ADDR']) ? $_SERVER['LOCAL_ADDR'] : gethostbyname($_SERVER['SERVER_NAME'])); - } - - - $_checksum = defined('UCS_BASE_DIR')?md5($server_addr.UCS_BASE_DIR.'admin'):md5($server_addr.SB.'admin'); - if ($_SESSION['checksum'] != $_checksum) { - return false; - } - // check privilege type - if (!in_array($str_privilege_type, array('r', 'w'))) { - return false; - } - if (isset($_SESSION['priv'][$str_module_name][$str_privilege_type]) AND $_SESSION['priv'][$str_module_name][$str_privilege_type]) { - return true; - } - return false; - } - - - /** - * Static Method to write application activities logs - * - * @param object $obj_db - * @param string $str_log_type - * @param string $str_value_id - * @param string $str_location - * @param string $str_log_msg - * @return void - */ - public static function writeLogs($obj_db, $str_log_type, $str_value_id, $str_location, $str_log_msg, $str_log_submod=NULL, $str_log_action=NULL) - { - if (!$obj_db->error) { - // log table - $_log_date = date('Y-m-d H:i:s'); - $_log_table = 'system_log'; - // filter input - $str_log_type = $obj_db->escape_string(trim($str_log_type)); - $str_value_id = $obj_db->escape_string(trim($str_value_id)); - $str_location = $obj_db->escape_string(trim($str_location)); - $str_log_msg = $obj_db->escape_string(trim($str_log_msg)); - $str_log_submod = $obj_db->escape_string(trim($str_log_submod)); - $str_log_action = $obj_db->escape_string(trim($str_log_action)); - // insert log data to database - @$obj_db->query('INSERT INTO '.$_log_table.' - VALUES (NULL, \''.$str_log_type.'\', \''.$str_value_id.'\', \''.$str_location.'\','. - ' \''.$str_log_submod.'\''. - ', \''.$str_log_action.'\''. - ', \''.$str_log_msg.'\', \''.$_log_date.'\')'); - } - } - - - /** - * Static Method to get an ID of database table record - * - * @param object $obj_db - * @param string $str_table_name - * @param string $str_id_field - * @param string $str_value_field - * @param string $str_value - * @param array $arr_cache - * @return mixed - */ - public static function getID($obj_db, $str_table_name, $str_id_field, $str_value_field, $str_value, &$arr_cache = false) - { - $str_value = trim($str_value); - if ($arr_cache) { - if (isset($arr_cache[$str_value])) { - return $arr_cache[$str_value]; - } - } - if (!$obj_db->error) { - $id_q = $obj_db->query('SELECT '.$str_id_field.' FROM '.$str_table_name.' WHERE '.$str_value_field.'=\''.$obj_db->escape_string($str_value).'\''); - if ($id_q->num_rows > 0) { - $id_d = $id_q->fetch_row(); - unset($id_q); - // cache - if ($arr_cache) { - $arr_cache[$str_value] = $id_d[0]; - } - return $id_d[0]; - } else { - $_curr_date = date('Y-m-d'); - // if not found then we insert it as new value - $obj_db->query('INSERT IGNORE INTO '.$str_table_name.' ('.$str_value_field.', input_date, last_update) - VALUES (\''.$obj_db->escape_string($str_value).'\', \''.$_curr_date.'\', \''.$_curr_date.'\')'); - if (!$obj_db->error) { - // cache - if ($arr_cache) { - $arr_cache[$str_value] = $obj_db->insert_id; - } - return $obj_db->insert_id; - } - } - } - } - - - /** - * Static method to detect mobile browser - * - * @return boolean - * this script is taken from http://detectmobilebrowsers.com/ - **/ - public static function isMobileBrowser() - { - $_is_mobile_browser = false; - - if(preg_match('/android.+mobile|avantgo|bada\/|blackberry| - blazer|compal|elaine|fennec|hiptop|iemobile|ip(hone|od)| - iris|kindle|lge |maemo|midp|mmp|netfront|opera m(ob|in)i| - palm( os)?|phone|p(ixi|re)\/|plucker|pocket|psp|symbian| - treo|up\.(browser|link)|vodafone|wap|windows (ce|phone)| - xda|xiino/i', - @$_SERVER['HTTP_USER_AGENT']) - || preg_match('/1207|6310|6590|3gso|4thp|50[1-6]i|770s|802s| - a wa|abac|ac(er|oo|s\-)|ai(ko|rn)|al(av|ca|co)| - amoi|an(ex|ny|yw)|aptu|ar(ch|go)|as(te|us)|attw| - au(di|\-m|r |s )|avan|be(ck|ll|nq)|bi(lb|rd)|bl(ac|az)| - br(e|v)w|bumb|bw\-(n|u)|c55\/|capi|ccwa|cdm\-|cell|chtm|cldc| - cmd\-|co(mp|nd)|craw|da(it|ll|ng)|dbte|dc\-s|devi|dica|dmob| - do(c|p)o|ds(12|\-d)|el(49|ai)|em(l2|ul)|er(ic|k0)|esl8| - ez([4-7]0|os|wa|ze)|fetc|fly(\-|_)|g1 u|g560|gene|gf\-5|g\-mo| - go(\.w|od)|gr(ad|un)|haie|hcit|hd\-(m|p|t)|hei\-|hi(pt|ta)| - hp( i|ip)|hs\-c|ht(c(\-| |_|a|g|p|s|t)|tp)|hu(aw|tc)| - i\-(20|go|ma)|i230|iac( |\-|\/)|ibro|idea|ig01|ikom|im1k|inno| - ipaq|iris|ja(t|v)a|jbro|jemu|jigs|kddi|keji|kgt( |\/)|klon|kpt | - kwc\-|kyo(c|k)|le(no|xi)|lg( g|\/(k|l|u)|50|54|e\-|e\/|\-[a-w])| - libw|lynx|m1\-w|m3ga|m50\/|ma(te|ui|xo)|mc(01|21|ca)|m\-cr| - me(di|rc|ri)|mi(o8|oa|ts)|mmef|mo(01|02|bi|de|do| - t(\-| |o|v)|zz)|mt(50|p1|v )|mwbp|mywa|n10[0-2]|n20[2-3]| - n30(0|2)|n50(0|2|5)|n7(0(0|1)|10)|ne((c|m)\-|on|tf|wf|wg|wt)| - nok(6|i)|nzph|o2im|op(ti|wv)|oran|owg1|p800|pan(a|d|t)|pdxg| - pg(13|\-([1-8]|c))|phil|pire|pl(ay|uc)|pn\-2|po(ck|rt|se)|prox| - psio|pt\-g|qa\-a|qc(07|12|21|32|60|\-[2-7]|i\-)|qtek|r380|r600| - raks|rim9|ro(ve|zo)|s55\/|sa(ge|ma|mm|ms|ny|va)| - sc(01|h\-|oo|p\-)|sdk\/|se(c(\-|0|1)|47|mc|nd|ri)| - sgh\-|shar|sie(\-|m)|sk\-0|sl(45|id)|sm(al|ar|b3|it|t5)| - so(ft|ny)|sp(01|h\-|v\-|v )|sy(01|mb)|t2(18|50)|t6(00|10|18)| - ta(gt|lk)|tcl\-|tdg\-|tel(i|m)|tim\-|t\-mo|to(pl|sh)| - ts(70|m\-|m3|m5)|tx\-9|up(\.b|g1|si)|utst|v400|v750|veri| - vi(rg|te)|vk(40|5[0-3]|\-v)|vm40|voda|vulc| - vx(52|53|60|61|70|80|81|83|85|98)|w3c(\-| )|webc|whit| - wi(g |nc|nw)|wmlb|wonu|x700|xda(\-|2|g)|yas\-|your|zeto|zte\-/i', - substr(@$_SERVER['HTTP_USER_AGENT'],0,4))) - $_is_mobile_browser = true; - - return $_is_mobile_browser; - } - - - /** - * Static method to check if member already logged in or not - * - * @return boolean - **/ - public static function isMemberLogin() - { - $_logged_in = false; - $_logged_in = isset($_SESSION['mid']) && isset($_SESSION['m_name']); - return $_logged_in; - } - - - /** - * Static method to filter data - * - * @param mixed $mix_input: input data - * @param string $str_input_type: input type - * @param boolean $bool_trim: are input string trimmed - * - * @return mixed - **/ - public static function filterData($mix_input, $str_input_type = 'get', $bool_escape_sql = true, $bool_trim = true, $bool_strip_html = false) { - global $dbs; - - if (extension_loaded('filter')) { - if ($str_input_type == 'var') { - $mix_input = filter_var($mix_input, FILTER_SANITIZE_STRING); - } else if ($str_input_type == 'post') { - $mix_input = filter_input(INPUT_POST, $mix_input); - } else if ($str_input_type == 'cookie') { - $mix_input = filter_input(INPUT_COOKIE, $mix_input); - } else if ($str_input_type == 'session') { - $mix_input = filter_input(INPUT_SESSION, $mix_input); - } else { - $mix_input = filter_input(INPUT_GET, $mix_input); - } - } else { - if ($str_input_type == 'get') { - $mix_input = $_GET[$mix_input]; - } else if ($str_input_type == 'post') { - $mix_input = $_POST[$mix_input]; - } else if ($str_input_type == 'cookie') { - $mix_input = $_COOKIE[$mix_input]; - } else if ($str_input_type == 'session') { - $mix_input = $_SESSION[$mix_input]; - } - } - - // trim whitespace on string - if ($bool_trim) { $mix_input = trim($mix_input); } - // strip html - if ($bool_strip_html) { $mix_input = strip_tags($mix_input); } - // escape SQL string - if ($bool_escape_sql) { $mix_input = $dbs->escape_string($mix_input); } - - return $mix_input; - } - - - /** - * Static method to convert XML entities - * Code taken and modified from: - * Matt Robinson at http://inanimatt.com/php-convert-entities.html - * - * @param string $str_xml_data: string of xml data to check - * - * @return string - **/ - public static function convertXMLentities($str_xml_data) { - static $_ent_table = array('quot' => '"', - 'amp' => '&', - 'lt' => '<', - 'gt' => '>', - 'OElig' => 'Œ', - 'oelig' => 'œ', - 'Scaron' => 'Š', - 'scaron' => 'š', - 'Yuml' => 'Ÿ', - 'circ' => 'ˆ', - 'tilde' => '˜', - 'ensp' => ' ', - 'emsp' => ' ', - 'thinsp' => ' ', - 'zwnj' => '‌', - 'zwj' => '‍', - 'lrm' => '‎', - 'rlm' => '‏', - 'ndash' => '–', - 'mdash' => '—', - 'lsquo' => '‘', - 'rsquo' => '’', - 'sbquo' => '‚', - 'ldquo' => '“', - 'rdquo' => '”', - 'bdquo' => '„', - 'dagger' => '†', - 'Dagger' => '‡', - 'permil' => '‰', - 'lsaquo' => '‹', - 'rsaquo' => '›', - 'euro' => '€', - 'fnof' => 'ƒ', - 'Alpha' => 'Α', - 'Beta' => 'Β', - 'Gamma' => 'Γ', - 'Delta' => 'Δ', - 'Epsilon' => 'Ε', - 'Zeta' => 'Ζ', - 'Eta' => 'Η', - 'Theta' => 'Θ', - 'Iota' => 'Ι', - 'Kappa' => 'Κ', - 'Lambda' => 'Λ', - 'Mu' => 'Μ', - 'Nu' => 'Ν', - 'Xi' => 'Ξ', - 'Omicron' => 'Ο', - 'Pi' => 'Π', - 'Rho' => 'Ρ', - 'Sigma' => 'Σ', - 'Tau' => 'Τ', - 'Upsilon' => 'Υ', - 'Phi' => 'Φ', - 'Chi' => 'Χ', - 'Psi' => 'Ψ', - 'Omega' => 'Ω', - 'alpha' => 'α', - 'beta' => 'β', - 'gamma' => 'γ', - 'delta' => 'δ', - 'epsilon' => 'ε', - 'zeta' => 'ζ', - 'eta' => 'η', - 'theta' => 'θ', - 'iota' => 'ι', - 'kappa' => 'κ', - 'lambda' => 'λ', - 'mu' => 'μ', - 'nu' => 'ν', - 'xi' => 'ξ', - 'omicron' => 'ο', - 'pi' => 'π', - 'rho' => 'ρ', - 'sigmaf' => 'ς', - 'sigma' => 'σ', - 'tau' => 'τ', - 'upsilon' => 'υ', - 'phi' => 'φ', - 'chi' => 'χ', - 'psi' => 'ψ', - 'omega' => 'ω', - 'thetasym' => 'ϑ', - 'upsih' => 'ϒ', - 'piv' => 'ϖ', - 'bull' => '•', - 'hellip' => '…', - 'prime' => '′', - 'Prime' => '″', - 'oline' => '‾', - 'frasl' => '⁄', - 'weierp' => '℘', - 'image' => 'ℑ', - 'real' => 'ℜ', - 'trade' => '™', - 'alefsym' => 'ℵ', - 'larr' => '←', - 'uarr' => '↑', - 'rarr' => '→', - 'darr' => '↓', - 'harr' => '↔', - 'crarr' => '↵', - 'lArr' => '⇐', - 'uArr' => '⇑', - 'rArr' => '⇒', - 'dArr' => '⇓', - 'hArr' => '⇔', - 'forall' => '∀', - 'part' => '∂', - 'exist' => '∃', - 'empty' => '∅', - 'nabla' => '∇', - 'isin' => '∈', - 'notin' => '∉', - 'ni' => '∋', - 'prod' => '∏', - 'sum' => '∑', - 'minus' => '−', - 'lowast' => '∗', - 'radic' => '√', - 'prop' => '∝', - 'infin' => '∞', - 'ang' => '∠', - 'and' => '∧', - 'or' => '∨', - 'cap' => '∩', - 'cup' => '∪', - 'int' => '∫', - 'there4' => '∴', - 'sim' => '∼', - 'cong' => '≅', - 'asymp' => '≈', - 'ne' => '≠', - 'equiv' => '≡', - 'le' => '≤', - 'ge' => '≥', - 'sub' => '⊂', - 'sup' => '⊃', - 'nsub' => '⊄', - 'sube' => '⊆', - 'supe' => '⊇', - 'oplus' => '⊕', - 'otimes' => '⊗', - 'perp' => '⊥', - 'sdot' => '⋅', - 'lceil' => '⌈', - 'rceil' => '⌉', - 'lfloor' => '⌊', - 'rfloor' => '⌋', - 'lang' => '〈', - 'rang' => '〉', - 'loz' => '◊', - 'spades' => '♠', - 'clubs' => '♣', - 'hearts' => '♥', - 'diams' => '♦', - 'nbsp' => ' ', - 'iexcl' => '¡', - 'cent' => '¢', - 'pound' => '£', - 'curren' => '¤', - 'yen' => '¥', - 'brvbar' => '¦', - 'sect' => '§', - 'uml' => '¨', - 'copy' => '©', - 'ordf' => 'ª', - 'laquo' => '«', - 'not' => '¬', - 'shy' => '­', - 'reg' => '®', - 'macr' => '¯', - 'deg' => '°', - 'plusmn' => '±', - 'sup2' => '²', - 'sup3' => '³', - 'acute' => '´', - 'micro' => 'µ', - 'para' => '¶', - 'middot' => '·', - 'cedil' => '¸', - 'sup1' => '¹', - 'ordm' => 'º', - 'raquo' => '»', - 'frac14' => '¼', - 'frac12' => '½', - 'frac34' => '¾', - 'iquest' => '¿', - 'Agrave' => 'À', - 'Aacute' => 'Á', - 'Acirc' => 'Â', - 'Atilde' => 'Ã', - 'Auml' => 'Ä', - 'Aring' => 'Å', - 'AElig' => 'Æ', - 'Ccedil' => 'Ç', - 'Egrave' => 'È', - 'Eacute' => 'É', - 'Ecirc' => 'Ê', - 'Euml' => 'Ë', - 'Igrave' => 'Ì', - 'Iacute' => 'Í', - 'Icirc' => 'Î', - 'Iuml' => 'Ï', - 'ETH' => 'Ð', - 'Ntilde' => 'Ñ', - 'Ograve' => 'Ò', - 'Oacute' => 'Ó', - 'Ocirc' => 'Ô', - 'Otilde' => 'Õ', - 'Ouml' => 'Ö', - 'times' => '×', - 'Oslash' => 'Ø', - 'Ugrave' => 'Ù', - 'Uacute' => 'Ú', - 'Ucirc' => 'Û', - 'Uuml' => 'Ü', - 'Yacute' => 'Ý', - 'THORN' => 'Þ', - 'szlig' => 'ß', - 'agrave' => 'à', - 'aacute' => 'á', - 'acirc' => 'â', - 'atilde' => 'ã', - 'auml' => 'ä', - 'aring' => 'å', - 'aelig' => 'æ', - 'ccedil' => 'ç', - 'egrave' => 'è', - 'eacute' => 'é', - 'ecirc' => 'ê', - 'euml' => 'ë', - 'igrave' => 'ì', - 'iacute' => 'í', - 'icirc' => 'î', - 'iuml' => 'ï', - 'eth' => 'ð', - 'ntilde' => 'ñ', - 'ograve' => 'ò', - 'oacute' => 'ó', - 'ocirc' => 'ô', - 'otilde' => 'õ', - 'ouml' => 'ö', - 'divide' => '÷', - 'oslash' => 'ø', - 'ugrave' => 'ù', - 'uacute' => 'ú', - 'ucirc' => 'û', - 'uuml' => 'ü', - 'yacute' => 'ý', - 'thorn' => 'þ', - 'yuml' => 'ÿ' - ); - - // Entity not found? Destroy it. - return isset($_ent_table[$str_xml_data[1]]) ? $_ent_table[$str_xml_data[1]] : ''; - } - - /** - * Static Method to load admin template - * - * @param object $obj_db - * @return void - */ - public static function loadUserTemplate($obj_db,$uid) - { - global $sysconf; - // load user template settings for override setting - $_q = $obj_db->query("SELECT admin_template FROM user WHERE user_id=$uid AND (admin_template!=NULL OR admin_template !='')"); - if($_q->num_rows>0){ - $template_settings = unserialize($_q->fetch_row()[0]); - foreach ($template_settings as $setting_name => $setting_value) { - $sysconf['admin_template'][$setting_name] = $setting_value; - } - } - } - - public static function dlCount($obj_db, $str_file_id, $str_member_id, $str_user_id) - { - if (!$obj_db->error) { - // log table - $_log_date = date('Y-m-d H:i:s'); - $_log_table = 'files_read'; - // filter input - $str_log_type = $obj_db->escape_string(trim($str_file_id)); - $str_value_id = $obj_db->escape_string(trim($str_member_id)); - $str_user_id = $obj_db->escape_string(trim($str_user_id)); - // insert log data to database - @$obj_db->query('INSERT INTO '.$_log_table.' - VALUES (NULL, \''.$str_file_id.'\', \''.$_log_date.'\', \''.$str_value_id.'\', \''.$str_user_id.'\', \''.$_SERVER[ - 'REMOTE_ADDR'].'\')'); - } - } -} +'."\n"; + echo 'alert("'.$str_message.'")'."\n"; + echo ''."\n"; + } + + /** + * Static Method to send out toastr notification + * + * @param string $type [info, success, warning, error] + * @param string $str_message + * @return void + */ + public static function jsToastr($title, $str_message, $type = 'info') + { + if (!$str_message) { + return; + } + + $options = [ + 'closeButton' => true, + 'debug' => false, + 'newestOnTop' => false, + 'progressBar' => false, + 'positionClass' => 'toast-top-right', + 'preventDuplicates' => false, + 'onclick' => null, + 'showDuration' => 300, + 'hideDuration' => 1000, + 'timeOut' => 5000, + 'extendedTimeOut' => 1000, + 'showEasing' => 'swing', + 'hideEasing' => 'linear', + 'showMethod' => 'fadeIn', + 'hideMethod' => 'fadeOut' + ]; + + // replace newline with javascripts newline + $str_message = str_replace("\n", '\n', addslashes($str_message)); + echo ''."\n"; + } + + + /** + * Static Method to create random string + * + * @param int $int_num_string: number of randowm string to created + * @return void + */ + public static function createRandomString($int_num_string = 32) + { + $_random = ''; + $_salt = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'; + $_saltlength = strlen($_salt); + for ($r = 0; $r < $int_num_string; $r++) { + $_random .= $_salt[rand(0, $_saltlength - 1)]; + } + + return $_random; + } + + + /** + * Static Method to load application settings from database + * + * @param object $obj_db + * @return void + */ + public static function loadSettings($obj_db) + { + global $sysconf; + $_setting_query = $obj_db->query('SELECT * FROM setting'); + if (!$obj_db->errno) { + while ($_setting_data = $_setting_query->fetch_assoc()) { + $_value = @unserialize($_setting_data['setting_value']); + if (is_array($_value)) { + // make sure setting is available before + if (!isset($sysconf[$_setting_data['setting_name']])) + $sysconf[$_setting_data['setting_name']] = []; + + foreach ($_value as $_idx => $_curr_value) { + // convert default setting value into array + if (!is_array($sysconf[$_setting_data['setting_name']])) + $sysconf[$_setting_data['setting_name']] = [$sysconf[$_setting_data['setting_name']]]; + $sysconf[$_setting_data['setting_name']][$_idx] = $_curr_value; + } + } else { + $sysconf[$_setting_data['setting_name']] = stripcslashes($_value); + } + } + } + } + + + /** + * Static Method to check privileges of application module form current user + * + * @param string $str_module_name + * @param string $str_privilege_type + * @return boolean + */ + public static function havePrivilege($str_module_name, $str_privilege_type = 'r') + { + global $sysconf; + // checking checksum + if ($sysconf['load_balanced_env']) { + $server_addr = $_SERVER['REMOTE_ADDR']; + } else { + $server_addr = isset($_SERVER['SERVER_ADDR']) ? $_SERVER['SERVER_ADDR'] : (isset($_SERVER['LOCAL_ADDR']) ? $_SERVER['LOCAL_ADDR'] : gethostbyname($_SERVER['SERVER_NAME'])); + } + + + $_checksum = defined('UCS_BASE_DIR')?md5($server_addr.UCS_BASE_DIR.'admin'):md5($server_addr.SB.'admin'); + if ($_SESSION['checksum'] != $_checksum) { + return false; + } + // check privilege type + if (!in_array($str_privilege_type, array('r', 'w'))) { + return false; + } + if (isset($_SESSION['priv'][$str_module_name][$str_privilege_type]) AND $_SESSION['priv'][$str_module_name][$str_privilege_type]) { + return true; + } + return false; + } + + + /** + * Static Method to write application activities logs + * + * @param object $obj_db + * @param string $str_log_type + * @param string $str_value_id + * @param string $str_location + * @param string $str_log_msg + * @return void + */ + public static function writeLogs($obj_db, $str_log_type, $str_value_id, $str_location, $str_log_msg, $str_log_submod=NULL, $str_log_action=NULL) + { + if (!$obj_db->error) { + // log table + $_log_date = date('Y-m-d H:i:s'); + $_log_table = 'system_log'; + // filter input + $str_log_type = $obj_db->escape_string(trim($str_log_type)); + $str_value_id = $obj_db->escape_string(trim($str_value_id)); + $str_location = $obj_db->escape_string(trim($str_location)); + $str_log_msg = $obj_db->escape_string(trim($str_log_msg)); + $str_log_submod = $obj_db->escape_string(trim($str_log_submod)); + $str_log_action = $obj_db->escape_string(trim($str_log_action)); + // insert log data to database + @$obj_db->query('INSERT INTO '.$_log_table.' + VALUES (NULL, \''.$str_log_type.'\', \''.$str_value_id.'\', \''.$str_location.'\','. + ' \''.$str_log_submod.'\''. + ', \''.$str_log_action.'\''. + ', \''.$str_log_msg.'\', \''.$_log_date.'\')'); + } + } + + + /** + * Static Method to get an ID of database table record + * + * @param object $obj_db + * @param string $str_table_name + * @param string $str_id_field + * @param string $str_value_field + * @param string $str_value + * @param array $arr_cache + * @return mixed + */ + public static function getID($obj_db, $str_table_name, $str_id_field, $str_value_field, $str_value, &$arr_cache = false) + { + $str_value = trim($str_value); + if ($arr_cache) { + if (isset($arr_cache[$str_value])) { + return $arr_cache[$str_value]; + } + } + if (!$obj_db->error) { + $id_q = $obj_db->query('SELECT '.$str_id_field.' FROM '.$str_table_name.' WHERE '.$str_value_field.'=\''.$obj_db->escape_string($str_value).'\''); + if ($id_q->num_rows > 0) { + $id_d = $id_q->fetch_row(); + unset($id_q); + // cache + if ($arr_cache) { + $arr_cache[$str_value] = $id_d[0]; + } + return $id_d[0]; + } else { + $_curr_date = date('Y-m-d'); + // if not found then we insert it as new value + $obj_db->query('INSERT IGNORE INTO '.$str_table_name.' ('.$str_value_field.', input_date, last_update) + VALUES (\''.$obj_db->escape_string($str_value).'\', \''.$_curr_date.'\', \''.$_curr_date.'\')'); + if (!$obj_db->error) { + // cache + if ($arr_cache) { + $arr_cache[$str_value] = $obj_db->insert_id; + } + return $obj_db->insert_id; + } + } + } + } + + + /** + * Static method to detect mobile browser + * + * @return boolean + * this script is taken from http://detectmobilebrowsers.com/ + **/ + public static function isMobileBrowser() + { + $_is_mobile_browser = false; + + if(preg_match('/android.+mobile|avantgo|bada\/|blackberry| + blazer|compal|elaine|fennec|hiptop|iemobile|ip(hone|od)| + iris|kindle|lge |maemo|midp|mmp|netfront|opera m(ob|in)i| + palm( os)?|phone|p(ixi|re)\/|plucker|pocket|psp|symbian| + treo|up\.(browser|link)|vodafone|wap|windows (ce|phone)| + xda|xiino/i', + @$_SERVER['HTTP_USER_AGENT']) + || preg_match('/1207|6310|6590|3gso|4thp|50[1-6]i|770s|802s| + a wa|abac|ac(er|oo|s\-)|ai(ko|rn)|al(av|ca|co)| + amoi|an(ex|ny|yw)|aptu|ar(ch|go)|as(te|us)|attw| + au(di|\-m|r |s )|avan|be(ck|ll|nq)|bi(lb|rd)|bl(ac|az)| + br(e|v)w|bumb|bw\-(n|u)|c55\/|capi|ccwa|cdm\-|cell|chtm|cldc| + cmd\-|co(mp|nd)|craw|da(it|ll|ng)|dbte|dc\-s|devi|dica|dmob| + do(c|p)o|ds(12|\-d)|el(49|ai)|em(l2|ul)|er(ic|k0)|esl8| + ez([4-7]0|os|wa|ze)|fetc|fly(\-|_)|g1 u|g560|gene|gf\-5|g\-mo| + go(\.w|od)|gr(ad|un)|haie|hcit|hd\-(m|p|t)|hei\-|hi(pt|ta)| + hp( i|ip)|hs\-c|ht(c(\-| |_|a|g|p|s|t)|tp)|hu(aw|tc)| + i\-(20|go|ma)|i230|iac( |\-|\/)|ibro|idea|ig01|ikom|im1k|inno| + ipaq|iris|ja(t|v)a|jbro|jemu|jigs|kddi|keji|kgt( |\/)|klon|kpt | + kwc\-|kyo(c|k)|le(no|xi)|lg( g|\/(k|l|u)|50|54|e\-|e\/|\-[a-w])| + libw|lynx|m1\-w|m3ga|m50\/|ma(te|ui|xo)|mc(01|21|ca)|m\-cr| + me(di|rc|ri)|mi(o8|oa|ts)|mmef|mo(01|02|bi|de|do| + t(\-| |o|v)|zz)|mt(50|p1|v )|mwbp|mywa|n10[0-2]|n20[2-3]| + n30(0|2)|n50(0|2|5)|n7(0(0|1)|10)|ne((c|m)\-|on|tf|wf|wg|wt)| + nok(6|i)|nzph|o2im|op(ti|wv)|oran|owg1|p800|pan(a|d|t)|pdxg| + pg(13|\-([1-8]|c))|phil|pire|pl(ay|uc)|pn\-2|po(ck|rt|se)|prox| + psio|pt\-g|qa\-a|qc(07|12|21|32|60|\-[2-7]|i\-)|qtek|r380|r600| + raks|rim9|ro(ve|zo)|s55\/|sa(ge|ma|mm|ms|ny|va)| + sc(01|h\-|oo|p\-)|sdk\/|se(c(\-|0|1)|47|mc|nd|ri)| + sgh\-|shar|sie(\-|m)|sk\-0|sl(45|id)|sm(al|ar|b3|it|t5)| + so(ft|ny)|sp(01|h\-|v\-|v )|sy(01|mb)|t2(18|50)|t6(00|10|18)| + ta(gt|lk)|tcl\-|tdg\-|tel(i|m)|tim\-|t\-mo|to(pl|sh)| + ts(70|m\-|m3|m5)|tx\-9|up(\.b|g1|si)|utst|v400|v750|veri| + vi(rg|te)|vk(40|5[0-3]|\-v)|vm40|voda|vulc| + vx(52|53|60|61|70|80|81|83|85|98)|w3c(\-| )|webc|whit| + wi(g |nc|nw)|wmlb|wonu|x700|xda(\-|2|g)|yas\-|your|zeto|zte\-/i', + substr(@$_SERVER['HTTP_USER_AGENT'],0,4))) + $_is_mobile_browser = true; + + return $_is_mobile_browser; + } + + + /** + * Static method to check if member already logged in or not + * + * @return boolean + **/ + public static function isMemberLogin() + { + $_logged_in = false; + $_logged_in = isset($_SESSION['mid']) && isset($_SESSION['m_name']); + return $_logged_in; + } + + + /** + * Static method to filter data + * + * @param mixed $mix_input: input data + * @param string $str_input_type: input type + * @param boolean $bool_trim: are input string trimmed + * + * @return mixed + **/ + public static function filterData($mix_input, $str_input_type = 'get', $bool_escape_sql = true, $bool_trim = true, $bool_strip_html = false) { + global $dbs; + + if (extension_loaded('filter')) { + if ($str_input_type == 'var') { + $mix_input = filter_var($mix_input, FILTER_SANITIZE_STRING); + } else if ($str_input_type == 'post') { + $mix_input = filter_input(INPUT_POST, $mix_input); + } else if ($str_input_type == 'cookie') { + $mix_input = filter_input(INPUT_COOKIE, $mix_input); + } else if ($str_input_type == 'session') { + $mix_input = filter_input(INPUT_SESSION, $mix_input); + } else { + $mix_input = filter_input(INPUT_GET, $mix_input); + } + } else { + if ($str_input_type == 'get') { + $mix_input = $_GET[$mix_input]; + } else if ($str_input_type == 'post') { + $mix_input = $_POST[$mix_input]; + } else if ($str_input_type == 'cookie') { + $mix_input = $_COOKIE[$mix_input]; + } else if ($str_input_type == 'session') { + $mix_input = $_SESSION[$mix_input]; + } + } + + // trim whitespace on string + if ($bool_trim) { $mix_input = trim($mix_input); } + // strip html + if ($bool_strip_html) { $mix_input = strip_tags($mix_input); } + // escape SQL string + if ($bool_escape_sql) { $mix_input = $dbs->escape_string($mix_input); } + + return $mix_input; + } + + + /** + * Static method to convert XML entities + * Code taken and modified from: + * Matt Robinson at http://inanimatt.com/php-convert-entities.html + * + * @param string $str_xml_data: string of xml data to check + * + * @return string + **/ + public static function convertXMLentities($str_xml_data) { + static $_ent_table = array('quot' => '"', + 'amp' => '&', + 'lt' => '<', + 'gt' => '>', + 'OElig' => 'Œ', + 'oelig' => 'œ', + 'Scaron' => 'Š', + 'scaron' => 'š', + 'Yuml' => 'Ÿ', + 'circ' => 'ˆ', + 'tilde' => '˜', + 'ensp' => ' ', + 'emsp' => ' ', + 'thinsp' => ' ', + 'zwnj' => '‌', + 'zwj' => '‍', + 'lrm' => '‎', + 'rlm' => '‏', + 'ndash' => '–', + 'mdash' => '—', + 'lsquo' => '‘', + 'rsquo' => '’', + 'sbquo' => '‚', + 'ldquo' => '“', + 'rdquo' => '”', + 'bdquo' => '„', + 'dagger' => '†', + 'Dagger' => '‡', + 'permil' => '‰', + 'lsaquo' => '‹', + 'rsaquo' => '›', + 'euro' => '€', + 'fnof' => 'ƒ', + 'Alpha' => 'Α', + 'Beta' => 'Β', + 'Gamma' => 'Γ', + 'Delta' => 'Δ', + 'Epsilon' => 'Ε', + 'Zeta' => 'Ζ', + 'Eta' => 'Η', + 'Theta' => 'Θ', + 'Iota' => 'Ι', + 'Kappa' => 'Κ', + 'Lambda' => 'Λ', + 'Mu' => 'Μ', + 'Nu' => 'Ν', + 'Xi' => 'Ξ', + 'Omicron' => 'Ο', + 'Pi' => 'Π', + 'Rho' => 'Ρ', + 'Sigma' => 'Σ', + 'Tau' => 'Τ', + 'Upsilon' => 'Υ', + 'Phi' => 'Φ', + 'Chi' => 'Χ', + 'Psi' => 'Ψ', + 'Omega' => 'Ω', + 'alpha' => 'α', + 'beta' => 'β', + 'gamma' => 'γ', + 'delta' => 'δ', + 'epsilon' => 'ε', + 'zeta' => 'ζ', + 'eta' => 'η', + 'theta' => 'θ', + 'iota' => 'ι', + 'kappa' => 'κ', + 'lambda' => 'λ', + 'mu' => 'μ', + 'nu' => 'ν', + 'xi' => 'ξ', + 'omicron' => 'ο', + 'pi' => 'π', + 'rho' => 'ρ', + 'sigmaf' => 'ς', + 'sigma' => 'σ', + 'tau' => 'τ', + 'upsilon' => 'υ', + 'phi' => 'φ', + 'chi' => 'χ', + 'psi' => 'ψ', + 'omega' => 'ω', + 'thetasym' => 'ϑ', + 'upsih' => 'ϒ', + 'piv' => 'ϖ', + 'bull' => '•', + 'hellip' => '…', + 'prime' => '′', + 'Prime' => '″', + 'oline' => '‾', + 'frasl' => '⁄', + 'weierp' => '℘', + 'image' => 'ℑ', + 'real' => 'ℜ', + 'trade' => '™', + 'alefsym' => 'ℵ', + 'larr' => '←', + 'uarr' => '↑', + 'rarr' => '→', + 'darr' => '↓', + 'harr' => '↔', + 'crarr' => '↵', + 'lArr' => '⇐', + 'uArr' => '⇑', + 'rArr' => '⇒', + 'dArr' => '⇓', + 'hArr' => '⇔', + 'forall' => '∀', + 'part' => '∂', + 'exist' => '∃', + 'empty' => '∅', + 'nabla' => '∇', + 'isin' => '∈', + 'notin' => '∉', + 'ni' => '∋', + 'prod' => '∏', + 'sum' => '∑', + 'minus' => '−', + 'lowast' => '∗', + 'radic' => '√', + 'prop' => '∝', + 'infin' => '∞', + 'ang' => '∠', + 'and' => '∧', + 'or' => '∨', + 'cap' => '∩', + 'cup' => '∪', + 'int' => '∫', + 'there4' => '∴', + 'sim' => '∼', + 'cong' => '≅', + 'asymp' => '≈', + 'ne' => '≠', + 'equiv' => '≡', + 'le' => '≤', + 'ge' => '≥', + 'sub' => '⊂', + 'sup' => '⊃', + 'nsub' => '⊄', + 'sube' => '⊆', + 'supe' => '⊇', + 'oplus' => '⊕', + 'otimes' => '⊗', + 'perp' => '⊥', + 'sdot' => '⋅', + 'lceil' => '⌈', + 'rceil' => '⌉', + 'lfloor' => '⌊', + 'rfloor' => '⌋', + 'lang' => '〈', + 'rang' => '〉', + 'loz' => '◊', + 'spades' => '♠', + 'clubs' => '♣', + 'hearts' => '♥', + 'diams' => '♦', + 'nbsp' => ' ', + 'iexcl' => '¡', + 'cent' => '¢', + 'pound' => '£', + 'curren' => '¤', + 'yen' => '¥', + 'brvbar' => '¦', + 'sect' => '§', + 'uml' => '¨', + 'copy' => '©', + 'ordf' => 'ª', + 'laquo' => '«', + 'not' => '¬', + 'shy' => '­', + 'reg' => '®', + 'macr' => '¯', + 'deg' => '°', + 'plusmn' => '±', + 'sup2' => '²', + 'sup3' => '³', + 'acute' => '´', + 'micro' => 'µ', + 'para' => '¶', + 'middot' => '·', + 'cedil' => '¸', + 'sup1' => '¹', + 'ordm' => 'º', + 'raquo' => '»', + 'frac14' => '¼', + 'frac12' => '½', + 'frac34' => '¾', + 'iquest' => '¿', + 'Agrave' => 'À', + 'Aacute' => 'Á', + 'Acirc' => 'Â', + 'Atilde' => 'Ã', + 'Auml' => 'Ä', + 'Aring' => 'Å', + 'AElig' => 'Æ', + 'Ccedil' => 'Ç', + 'Egrave' => 'È', + 'Eacute' => 'É', + 'Ecirc' => 'Ê', + 'Euml' => 'Ë', + 'Igrave' => 'Ì', + 'Iacute' => 'Í', + 'Icirc' => 'Î', + 'Iuml' => 'Ï', + 'ETH' => 'Ð', + 'Ntilde' => 'Ñ', + 'Ograve' => 'Ò', + 'Oacute' => 'Ó', + 'Ocirc' => 'Ô', + 'Otilde' => 'Õ', + 'Ouml' => 'Ö', + 'times' => '×', + 'Oslash' => 'Ø', + 'Ugrave' => 'Ù', + 'Uacute' => 'Ú', + 'Ucirc' => 'Û', + 'Uuml' => 'Ü', + 'Yacute' => 'Ý', + 'THORN' => 'Þ', + 'szlig' => 'ß', + 'agrave' => 'à', + 'aacute' => 'á', + 'acirc' => 'â', + 'atilde' => 'ã', + 'auml' => 'ä', + 'aring' => 'å', + 'aelig' => 'æ', + 'ccedil' => 'ç', + 'egrave' => 'è', + 'eacute' => 'é', + 'ecirc' => 'ê', + 'euml' => 'ë', + 'igrave' => 'ì', + 'iacute' => 'í', + 'icirc' => 'î', + 'iuml' => 'ï', + 'eth' => 'ð', + 'ntilde' => 'ñ', + 'ograve' => 'ò', + 'oacute' => 'ó', + 'ocirc' => 'ô', + 'otilde' => 'õ', + 'ouml' => 'ö', + 'divide' => '÷', + 'oslash' => 'ø', + 'ugrave' => 'ù', + 'uacute' => 'ú', + 'ucirc' => 'û', + 'uuml' => 'ü', + 'yacute' => 'ý', + 'thorn' => 'þ', + 'yuml' => 'ÿ' + ); + + // Entity not found? Destroy it. + return isset($_ent_table[$str_xml_data[1]]) ? $_ent_table[$str_xml_data[1]] : ''; + } + + /** + * Static Method to load admin template + * + * @param object $obj_db + * @return void + */ + public static function loadUserTemplate($obj_db,$uid) + { + global $sysconf; + // load user template settings for override setting + $_q = $obj_db->query("SELECT admin_template FROM user WHERE user_id=$uid AND (admin_template!=NULL OR admin_template !='')"); + if($_q->num_rows>0){ + $template_settings = unserialize($_q->fetch_row()[0]); + foreach ($template_settings as $setting_name => $setting_value) { + $sysconf['admin_template'][$setting_name] = $setting_value; + } + } + } + + public static function dlCount($obj_db, $str_file_id, $str_member_id, $str_user_id) + { + if (!$obj_db->error) { + // log table + $_log_date = date('Y-m-d H:i:s'); + $_log_table = 'files_read'; + // filter input + $str_log_type = $obj_db->escape_string(trim($str_file_id)); + $str_value_id = $obj_db->escape_string(trim($str_member_id)); + $str_user_id = $obj_db->escape_string(trim($str_user_id)); + // insert log data to database + @$obj_db->query('INSERT INTO '.$_log_table.' + VALUES (NULL, \''.$str_file_id.'\', \''.$_log_date.'\', \''.$str_value_id.'\', \''.$str_user_id.'\', \''.$_SERVER[ + 'REMOTE_ADDR'].'\')'); + } + } +} diff --git a/simbio2/simbio_GUI/form_maker/simbio_form_element.inc.php b/simbio2/simbio_GUI/form_maker/simbio_form_element.inc.php index 9c254c03..967489b2 100755 --- a/simbio2/simbio_GUI/form_maker/simbio_form_element.inc.php +++ b/simbio2/simbio_GUI/form_maker/simbio_form_element.inc.php @@ -131,7 +131,7 @@ public function out() $_buffer .= ''."\n"; } else { - $_buffer .= ''."\n"; } } diff --git a/simbio2/simbio_GUI/table/simbio_table.inc.php b/simbio2/simbio_GUI/table/simbio_table.inc.php index 4098e57f..bf530c5a 100755 --- a/simbio2/simbio_GUI/table/simbio_table.inc.php +++ b/simbio2/simbio_GUI/table/simbio_table.inc.php @@ -199,7 +199,7 @@ public function getColumnContent($int_row, $int_column, $str_column_content) * @param string $str_column_attr * @return void */ - public function setCellAttr($int_row = 0, $int_column = null, $str_column_attr) + public function setCellAttr($int_row = 0, $int_column = null, $str_column_attr = null) { if (is_null($int_column)) { $this->row_attr[$int_row] = $str_column_attr; diff --git a/simbio2/simbio_UTILS/simbio_tokenizecql.inc.php b/simbio2/simbio_UTILS/simbio_tokenizecql.inc.php index c5a0e56f..474c2194 100755 --- a/simbio2/simbio_UTILS/simbio_tokenizecql.inc.php +++ b/simbio2/simbio_UTILS/simbio_tokenizecql.inc.php @@ -34,7 +34,7 @@ * * @param string $str_query * @param array $arr_stop_words - * @return string + * @return array **/ function simbio_tokenizeCQL($str_query, $arr_searcheable_fields, $arr_stop_words = array(), $int_max_words = 20) { diff --git a/sysconfig.inc.php b/sysconfig.inc.php index e276f823..be5cce5f 100755 --- a/sysconfig.inc.php +++ b/sysconfig.inc.php @@ -27,12 +27,15 @@ die("can not access this file directly"); } +// Environment config +require 'config/sysconfig.env.inc.php'; + /* * Set to development or production * * In production mode, the system error message will be disabled */ -define('ENVIRONMENT', 'production'); +define('ENVIRONMENT', $Environment); switch (ENVIRONMENT) { case 'development': @@ -506,6 +509,7 @@ /** * Mailing Settings */ +$sysconf['mail']['debug'] = 0; $sysconf['mail']['SMTPSecure'] = 'ssl'; // ssl or tls $sysconf['mail']['enable'] = true; $sysconf['mail']['server'] = 'ssl://smtp.gmail.com:465'; // SMTP server @@ -518,6 +522,9 @@ $sysconf['mail']['reply_to'] = &$sysconf['mail']['from']; $sysconf['mail']['reply_to_name'] = &$sysconf['mail']['from_name']; +if (file_exists(SB.'config'.DS.'sysconfig.mail.inc.php')) { + include SB.'config'.DS.'sysconfig.mail.inc.php'; +} /** * Maximum biblio mark for member */ diff --git a/template/akasia-dz/biblio_list_template.php b/template/akasia-dz/biblio_list_template.php index cb8d0ed7..970ab035 100644 --- a/template/akasia-dz/biblio_list_template.php +++ b/template/akasia-dz/biblio_list_template.php @@ -89,7 +89,10 @@ function biblio_list_format($dbs, $biblio_detail, $n, $settings = array(), &$ret if (!empty($biblio_detail['image']) && !defined('LIGHTWEIGHT_MODE')) { $biblio_detail['image'] = urlencode($biblio_detail['image']); $images_loc = 'images/docs/'.$biblio_detail['image']; - if ($sysconf['tg']['type'] == 'minigalnano') { + if($biblio_detail['image'] == '' || $biblio_detail['image'] == NULL){ + $images_loc = 'images/default/image.png'; + } + if ($sysconf['tg']['type'] == 'minigalnano') { $thumb_url = './lib/minigalnano/createthumb.php?filename='.urlencode($images_loc).'&width=120'; $image_cover = ''.$title.''; } diff --git a/template/akasia-dz/partials/meta.php b/template/akasia-dz/partials/meta.php index 5d8e2c64..a642db56 100644 --- a/template/akasia-dz/partials/meta.php +++ b/template/akasia-dz/partials/meta.php @@ -78,6 +78,11 @@ + diff --git a/template/akasia/biblio_list_template.php b/template/akasia/biblio_list_template.php index 1c679e32..261743cc 100644 --- a/template/akasia/biblio_list_template.php +++ b/template/akasia/biblio_list_template.php @@ -90,6 +90,9 @@ function biblio_list_format($dbs, $biblio_detail, $n, $settings = array(), &$ret if (!empty($biblio_detail['image']) && !defined('LIGHTWEIGHT_MODE')) { $biblio_detail['image'] = urlencode($biblio_detail['image']); $images_loc = 'images/docs/'.$biblio_detail['image']; + if($biblio_detail['image'] == '' || $biblio_detail['image'] == NULL){ + $images_loc = 'images/default/image.png'; + } if ($sysconf['tg']['type'] == 'minigalnano') { $thumb_url = './lib/minigalnano/createthumb.php?filename='.urlencode($images_loc).'&width=120'; $image_cover = ''.$title.''; diff --git a/template/akasia/partials/meta.php b/template/akasia/partials/meta.php index e751ea25..7f482f7f 100644 --- a/template/akasia/partials/meta.php +++ b/template/akasia/partials/meta.php @@ -78,6 +78,11 @@ + diff --git a/template/akasia/style.css b/template/akasia/style.css index d4f49e7e..b639046d 100644 --- a/template/akasia/style.css +++ b/template/akasia/style.css @@ -2189,6 +2189,7 @@ keyframes coverUp 100% { } #visitorCounterPhoto { margin: 0; + width: 100px; } /* Social Icon ================================ */ diff --git a/template/default/biblio_list_template.php b/template/default/biblio_list_template.php index 253be2d3..c28f74ca 100644 --- a/template/default/biblio_list_template.php +++ b/template/default/biblio_list_template.php @@ -50,6 +50,9 @@ function biblio_list_format($dbs, $biblio_detail, $n, $settings = array(), &$ret // image thumbnail $images_loc = 'images/docs/'.$biblio_detail['image']; + if($biblio_detail['image'] == '' || $biblio_detail['image'] == NULL){ + $images_loc = 'images/default/image.png'; + } $thumb_url = './lib/minigalnano/createthumb.php?filename='.urlencode($images_loc).'&width=120'; // notes diff --git a/template/default/parts/header.php b/template/default/parts/header.php index 027817aa..3700d78f 100644 --- a/template/default/parts/header.php +++ b/template/default/parts/header.php @@ -95,6 +95,11 @@ + diff --git a/template/default/visitor_template.php b/template/default/visitor_template.php index 1f57dd1f..426d03e5 100644 --- a/template/default/visitor_template.php +++ b/template/default/visitor_template.php @@ -62,7 +62,6 @@

-

@@ -98,7 +97,8 @@ this.image = './images/persons/photo.png' }, getQuotes: function() { - axios.get('https://api.quotable.io/random') + // Alternative Free Quotes API: https://api.quotable.io/random + axios.get('https://kutipan.herokuapp.com/') .then(res => { this.quotes = res.data }) @@ -130,8 +130,8 @@ headers: {'Content-Type': 'multipart/form-data' } }) .then(res => { - this.textInfo = res.data - this.image = `./images/persons/member_${this.memberId}.jpg` + this.textInfo = res.data.message + this.image = `./images/persons/${res.data.image}` this.textToSpeech(this.textInfo.replace(/(<([^>]+)>)/ig, '')) diff --git a/template/lightweight/biblio_list_template.php b/template/lightweight/biblio_list_template.php index cb8d0ed7..0405ae67 100644 --- a/template/lightweight/biblio_list_template.php +++ b/template/lightweight/biblio_list_template.php @@ -89,6 +89,9 @@ function biblio_list_format($dbs, $biblio_detail, $n, $settings = array(), &$ret if (!empty($biblio_detail['image']) && !defined('LIGHTWEIGHT_MODE')) { $biblio_detail['image'] = urlencode($biblio_detail['image']); $images_loc = 'images/docs/'.$biblio_detail['image']; + if($biblio_detail['image'] == '' || $biblio_detail['image'] == NULL){ + $images_loc = 'images/default/image.png'; + } if ($sysconf['tg']['type'] == 'minigalnano') { $thumb_url = './lib/minigalnano/createthumb.php?filename='.urlencode($images_loc).'&width=120'; $image_cover = ''.$title.''; diff --git a/template/lightweight/partials/meta.php b/template/lightweight/partials/meta.php index c0411179..e58db038 100644 --- a/template/lightweight/partials/meta.php +++ b/template/lightweight/partials/meta.php @@ -81,6 +81,11 @@ --> +