# photonic/2.25/extensions/Photonic_Zenfolio_Processor.php
Photonic Gallery & Lightbox for Flickr, SmugMug & Others, version 2.25. 1,234 lines.
- Page: https://pluginprobe.com/plugins/photonic/2.25/code/extensions/Photonic_Zenfolio_Processor.php
- Raw: https://pluginprobe.com/plugins/photonic/2.25/raw/extensions/Photonic_Zenfolio_Processor.php
- Modified: 2019-02-28T00:11:30+00:00
Line numbers below start at 1. Link to a line or a range by appending a fragment to the
page URL, for example `https://pluginprobe.com/plugins/photonic/2.25/code/extensions/Photonic_Zenfolio_Processor.php#L10-L20`.
```php
provider = 'zenfolio';
$this->user_agent = "Photonic for ".get_home_url();
$this->link_lightbox_title = empty($photonic_zenfolio_disable_title_link);
$this->service_url = 'https://api.zenfolio.com/api/1.8/zfapi.asmx';
$this->secure_url = 'https://api.zenfolio.com/api/1.8/zfapi.asmx';
$this->unlocked_realms = array();
$this->doc_links = array(
'general' => 'https://aquoid.com/plugins/photonic/zenfolio/',
'photos' => 'https://aquoid.com/plugins/photonic/zenfolio/photos/',
'photosets' => 'https://aquoid.com/plugins/photonic/zenfolio/photosets/',
'groups' => 'https://aquoid.com/plugins/photonic/zenfolio/group/',
'hierarchies' => 'https://aquoid.com/plugins/photonic/zenfolio/group-hierarchy/',
);
$this->perform_back_end_authentication();
}
/**
* Main function that fetches the images associated with the shortcode.
*
* @param array $attr
* @return string
*/
public function get_gallery_images($attr = array()) {
global $photonic_zenfolio_thumb_size, $photonic_zenfolio_main_size, $photonic_zenfolio_tile_size, $photonic_zenfolio_title_caption, $photonic_zenfolio_video_size, $photonic_zenfolio_media, $photonic_zenfolio_default_user;
$this->gallery_index++;
$this->push_to_stack('Get Gallery Images');
$attr = array_merge(
$this->common_parameters,
array(
'caption' => $photonic_zenfolio_title_caption,
'thumb_size' => $photonic_zenfolio_thumb_size,
'main_size' => $photonic_zenfolio_main_size,
'video_size' => $photonic_zenfolio_video_size,
'tile_size' => $photonic_zenfolio_tile_size,
'count' => 500,
'offset' => 0,
'media' => $photonic_zenfolio_media,
'structure' => 'nested',
'login_name' => $photonic_zenfolio_default_user,
), $attr);
$attr = array_map('trim', $attr);
$attr['limit'] = empty($attr['limit']) ? $attr['count'] : $attr['limit'];
$attr['photo_count'] = empty($attr['photo_count']) ? $attr['limit'] : $attr['photo_count'];
$attr['overlay_size'] = empty($attr['overlay_size']) ? $attr['thumb_size'] : $attr['overlay_size'];
$attr['overlay_video_size'] = empty($attr['overlay_video_size']) ? $attr['video_size'] : $attr['overlay_video_size'];
extract($attr);
if (isset($_COOKIE['photonic-zf-keyring'])) {
$realms = $this->make_call('KeyringGetUnlockedRealms', array('keyring' => $_COOKIE['photonic-zf-keyring']));
if (!empty($realms) && !empty($realms->result)) {
$this->unlocked_realms = $realms->result;
}
}
$chained_methods = array();
$zenfolio_params = array();
$attr['headers_already_called'] = true;
if (!empty($attr['view'])) {
switch ($attr['view']) {
case 'photos':
if (!empty($object_id)) {
$chained_methods[] = 'LoadPhoto';
if(($h = stripos($object_id, 'h')) !== false) {
$object_id = substr($object_id, $h + 1);
$object_id = hexdec($object_id);
}
else if (($p = stripos($object_id, 'p')) !== false) {
$object_id = substr($object_id, $p + 1);
}
else if (strlen($object_id) == 7) {
$object_id = hexdec($object_id);
}
$zenfolio_params['photoId'] = $object_id;
$zenfolio_params['level'] = 'Full';
}
else if (!empty($text)) {
$zenfolio_params['searchId'] = '';
if (!empty($sort_order)) {
$zenfolio_params['sortOrder'] = $sort_order; // Popularity | Date | Rank
}
else {
$zenfolio_params['sortOrder'] = 'Date';
}
$zenfolio_params['query'] = $text;
$zenfolio_params['offset'] = $attr['offset'];
$zenfolio_params['limit'] = $attr['limit'];
$chained_methods[] = 'SearchPhotoByText';
}
else if (!empty($category_code)) {
$zenfolio_params['searchId'] = '';
if (!empty($sort_order)) {
$zenfolio_params['sortOrder'] = $sort_order; // Popularity | Date
}
else {
$zenfolio_params['sortOrder'] = 'Date';
}
$zenfolio_params['categoryCode'] = $category_code;
$zenfolio_params['offset'] = $attr['offset'];
$zenfolio_params['limit'] = $attr['limit'];
$chained_methods[] = 'SearchPhotoByCategory';
}
else if (!empty($kind)) {
$zenfolio_params['offset'] = $attr['offset'];
$zenfolio_params['limit'] = $attr['limit'];
switch ($kind) {
case 'popular':
$chained_methods[] = 'GetPopularPhotos';
break;
case 'recent':
$chained_methods[] = 'GetRecentPhotos';
break;
default:
$this->pop_from_stack();
return $this->error(sprintf(esc_html__('Invalid %s parameter.', 'photonic'), 'kind').
Photonic::doc_link($this->doc_links['photos']));
}
}
else {
$this->pop_from_stack();
return $this->error(sprintf(esc_html__('The %1$s parameter is required if %2$s is not specified.', 'photonic'), 'kind', 'object_id').
Photonic::doc_link($this->doc_links['photos']));
}
break;
case 'photosets':
if (!empty($object_id)) {
if(($p = stripos($object_id, 'p')) !== false) {
$object_id = substr($object_id, $p + 1);
}
$zenfolio_params['photosetId'] = $object_id;
$zenfolio_params['level'] = 'Level1';
$zenfolio_params['includePhotos'] = false;
if (!empty($password) && empty($realm_id)) {
$first_call = $this->make_call('LoadPhotoSet', $zenfolio_params);
if (isset($first_call->result) && !empty($first_call->result)) {
$photoset = $first_call->result;
if (isset($photoset->AccessDescriptor)) {
$realm_id = $photoset->AccessDescriptor->Id;
}
}
}
if (!empty($password) && !empty($realm_id)) {
if (!in_array($realm_id, $this->unlocked_realms)) {
$attr['headers_already_called'] = empty($attr['panel']); //false;
$chained_methods[] = 'KeyringAddKeyPlain';
$zenfolio_params['keyring'] = empty($_COOKIE['photonic-zf-keyring']) ? '' : $_COOKIE['photonic-zf-keyring'];
$zenfolio_params['realmId'] = $realm_id;
$zenfolio_params['password'] = $password;
}
}
$chained_methods[] = 'LoadPhotoSet';
$zenfolio_params['startingIndex'] = $attr['offset'];
$zenfolio_params['numberOfPhotos'] = $attr['limit'];
$chained_methods[] = 'LoadPhotoSetPhotos';
}
else if (!empty($login_name)) {
$chained_methods[] = 'LoadGroupHierarchy';
$attr['structure'] = 'flat';
$zenfolio_params['loginName'] = $login_name;
}
else if (!empty($text) && !empty($photoset_type)) {
$zenfolio_params['searchId'] = '';
if (strtolower($photoset_type) == 'gallery' || strtolower($photoset_type) == 'galleries') {
$zenfolio_params['type'] = 'Gallery';
}
else if (strtolower($photoset_type) == 'collection' || strtolower($photoset_type) == 'collections') {
$zenfolio_params['type'] = 'Collection';
}
else {
$this->pop_from_stack();
return $this->error(sprintf(esc_html__('Invalid %1$s parameter. Permissible values are %2$s or %3$s.', 'photonic'), 'photoset_type', 'Gallery', 'Collection').
Photonic::doc_link($this->doc_links['photosets']));
}
if (!empty($sort_order)) {
$zenfolio_params['sortOrder'] = $sort_order; // Popularity | Date | Rank
}
else {
$zenfolio_params['sortOrder'] = 'Rank';
}
$zenfolio_params['query'] = $text;
$zenfolio_params['offset'] = $attr['offset'];
$zenfolio_params['limit'] = $attr['limit'];
$chained_methods[] = 'SearchSetByText';
}
else if (!empty($category_code) && !empty($photoset_type)) {
$zenfolio_params['searchId'] = '';
if (strtolower($photoset_type) == 'gallery' || strtolower($photoset_type) == 'galleries') {
$zenfolio_params['type'] = 'Gallery';
}
else if (strtolower($photoset_type) == 'collection' || strtolower($photoset_type) == 'collections') {
$zenfolio_params['type'] = 'Collection';
}
else {
$this->pop_from_stack();
return $this->error(sprintf(esc_html__('Invalid %1$s parameter. Permissible values are %2$s or %3$s.', 'photonic'), 'photoset_type', 'Gallery', 'Collection').
Photonic::doc_link($this->doc_links['photosets']));
}
if (!empty($sort_order)) {
$zenfolio_params['sortOrder'] = $sort_order; // Popularity | Date
}
else {
$zenfolio_params['sortOrder'] = 'Date';
}
$zenfolio_params['categoryCode'] = $category_code;
$zenfolio_params['offset'] = $attr['offset'];
$zenfolio_params['limit'] = $attr['limit'];
$chained_methods[] = 'SearchSetByCategory';
}
else if (!empty($kind) && !empty($photoset_type)) {
switch ($kind) {
case 'popular':
$chained_methods[] = 'GetPopularSets';
break;
case 'recent':
$chained_methods[] = 'GetRecentSets';
break;
default:
$this->pop_from_stack();
return $this->error(sprintf(esc_html__('Invalid %s parameter.', 'photonic'), 'kind').
Photonic::doc_link($this->doc_links['photosets']));
}
if (strtolower($photoset_type) == 'gallery' || strtolower($photoset_type) == 'galleries') {
$zenfolio_params['type'] = 'Gallery';
}
else if (strtolower($photoset_type) == 'collection' || strtolower($photoset_type) == 'collections') {
$zenfolio_params['type'] = 'Collection';
}
else {
$this->pop_from_stack();
return $this->error(sprintf(esc_html__('Invalid %1$s parameter. Permissible values are %2$s or %3$s.', 'photonic'), 'photoset_type', 'Gallery', 'Collection').
Photonic::doc_link($this->doc_links['photosets']));
}
// These have to be after the $params['type'] assignment
$zenfolio_params['offset'] = $attr['offset'];
$zenfolio_params['limit'] = $attr['limit'];
}
else if (!empty($filter) && empty($login_name)) {
$this->pop_from_stack();
return $this->error(sprintf(esc_html__('The %1$s parameter is required if %2$s is specified.', 'photonic'), 'login_name', 'filter').
Photonic::doc_link($this->doc_links['photosets']));
}
else if (empty($kind)) {
$this->pop_from_stack();
return $this->error(sprintf(esc_html__('The %1$s parameter is required if %2$s or %3$s is not specified.', 'photonic'), 'kind', 'object_id', 'login_name').
Photonic::doc_link($this->doc_links['photosets']));
}
else if (empty($photoset_type)) {
$this->pop_from_stack();
return $this->error(sprintf(esc_html__('The %1$s parameter is required if %2$s or %3$s is not specified.', 'photonic'), 'photoset_type', 'object_id', 'login_name').
Photonic::doc_link($this->doc_links['photosets']));
}
if (!empty($login_name) && !empty($category_code)) {
$attr['user_specific_category'] = true;
}
if (!empty($login_name) && !empty($text)) {
$attr['user_specific_text'] = true;
}
break;
case 'hierarchy':
if (empty($login_name)) {
$this->pop_from_stack();
return $this->error(sprintf(esc_html__('The %s parameter is required.', 'photonic'), 'login_name').
Photonic::doc_link($this->doc_links['hierarchies']));
}
$chained_methods[] = 'LoadGroupHierarchy';
$zenfolio_params['loginName'] = $login_name;
break;
case 'group':
if (empty($object_id)) {
$this->pop_from_stack();
return $this->error(sprintf(esc_html__('The %s parameter is required.', 'photonic'), 'object_id').
Photonic::doc_link($this->doc_links['groups']));
}
$chained_methods[] = 'LoadGroup';
if(($f = stripos($object_id, 'f')) !== false) {
$object_id = substr($object_id, $f + 1);
}
$zenfolio_params['groupId'] = $object_id;
$zenfolio_params['level'] = 'Full';
$zenfolio_params['includeChildren'] = true;
break;
}
}
if (!empty($attr['panel'])) {
$attr['display'] = 'popup';
}
else {
$attr['display'] = 'in-page';
}
$header_display = $this->get_header_display($attr);
$attr['header_display'] = $header_display;
$level_2_meta = array(
'start' => $attr['offset'],
'per-page' => $attr['limit'],
);
$attr['level_2_meta'] = $level_2_meta;
$call_return = $this->make_chained_calls($chained_methods, $zenfolio_params, $attr);
if ($call_return == $this->password_protected) {
$this->pop_from_stack();
return $call_return;
}
else if (empty($call_return)) {
$this->pop_from_stack();
return '';
}
$ret = $this->finalize_markup($call_return, $attr);
$this->pop_from_stack();
return $ret.$this->get_stack_markup();
}
/**
* Calls a Zenfolio method with the passed parameters. The method is called using JSON-RPC. WP's wp_remote_request
* method doesn't work here because of specific CURL parameter requirements.
*
* @param $method
* @param $params
* @param null $keyring
* @return array|mixed
*/
function make_call($method, $params, $keyring = null) {
$request = array();
$request['method'] = $method;
$request['params'] = array_values($params);
$request['id'] = 1;
$bodyString = json_encode($request);
$bodyLength = strlen($bodyString);
$headers = array();
$headers[] = 'Host: api.zenfolio.com';
$headers[] = 'User-Agent: '.$this->user_agent;
if ($this->token && $method !== 'GetChallenge' && $method !== 'Authenticate') {
$headers[] = 'X-Zenfolio-Token: '.$this->token;
}
if (isset($_COOKIE['photonic-zf-keyring'])) {
$headers[] = 'X-Zenfolio-Keyring: '.$_COOKIE['photonic-zf-keyring'];
}
else if (!empty($keyring)) {
$headers[] = 'X-Zenfolio-Keyring: '.$keyring;
}
$headers[] = 'Content-Type: application/json';
$headers[] = 'Content-Length: '.$bodyLength."\r\n";
$headers[] = $bodyString;
$ch = curl_init($this->secure_url);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, PHOTONIC_SSL_VERIFY);
curl_setopt($ch, CURLOPT_USERAGENT, $this->user_agent);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HEADER, FALSE);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
// curl_setopt($ch, CURLINFO_HEADER_OUT, true);
$response = curl_exec($ch);
curl_close($ch);
//PHP/WP's json_decode() function really messes up the "long" ids returned by Zenfolio. The following takes care of this.
// Can't pass the 4th argument as outlined here: https://php.net/manual/en/function.json-decode.php, since it only came into existence in PHP 5.4
$response = preg_replace('/"Id":(\d+)/', '"Id":"$1"', $response);
$response = preg_replace('/"RealmId":(\d+)/', '"Id":"$1"', $response);
if ($method == 'KeyringGetUnlockedRealms') {
$realm_ids = array();
preg_match('/([\[^,\d]+\])/', $response, $realm_ids);
if (!empty($realm_ids)) {
$realm_ids = $realm_ids[0];
$replace = $realm_ids;
$replace = str_replace('[', '["', $replace);
$replace = str_replace(']', '"]', $replace);
$replace = str_replace(',', '","', $replace);
$response = str_replace($realm_ids, $replace, $response);
}
}
$response = json_decode($response);
return $response;
}
/**
* @param $method
* @param null $params
* @param bool $ssl_verify_peer
* @param null $keyring
* @return array|mixed|null|object|string|string[]|WP_Error
*/
function make_wp_call($method, $params = null, $ssl_verify_peer = PHOTONIC_SSL_VERIFY, $keyring = null) {
$request = $this->prepare_request($method, $params, $keyring);
$response = $this->make_wp_request($method, $ssl_verify_peer, $request);
return $response;
}
/**
* Makes a sequence of calls to different Zenfolio methods. This is particularly useful in case of authenticated calls, where
* first the authentication happens, then the content is displayed, all in the same call.
*
* @param array $methods
* @param array $zenfolio_args
* @param array $short_code
* @return string
*/
function make_chained_calls($methods, $zenfolio_args, &$short_code = array()) {
$this->push_to_stack('Make chained calls');
$ret = '';
$keyring = null;
$original_params = array();
foreach ($zenfolio_args as $param => $value) {
$original_params[$param] = $value;
}
foreach ($methods as $method) {
$this->push_to_stack("Making call for $method");
$keyring_params = array();
if ($method == 'KeyringGetUnlockedRealms') {
$keyring_params['keyring'] = $zenfolio_args['keyring'];
$response = $this->make_call($method, $keyring_params);
if (isset($response->result)) {
$this->unlocked_realms = $response->result;
}
}
else if ($method == 'KeyringAddKeyPlain') {
if (in_array($zenfolio_args['realmId'], $this->unlocked_realms)) {
continue;
}
$keyring_params['keyring'] = $zenfolio_args['keyring'];
$keyring_params['realmId'] = $zenfolio_args['realmId'];
$keyring_params['password'] = $zenfolio_args['password'];
$response = $this->make_call($method, $keyring_params);
if (!empty($response->result)) {
// Sometimes the cookie isn't set by the setcookie command (happens when the password is passed as a shortcode parameter
// instead of the password prompt)
$keyring = $response->result;
if (!in_array($keyring_params['realmId'], $this->unlocked_realms)) {
$this->unlocked_realms[] = $keyring_params['realmId'];
}
if (!$short_code['headers_already_called']) {
setcookie('photonic-zf-keyring', $response->result, time() + 60 * 60 * 24, COOKIEPATH);
}
}
else {
$ret = $this->password_protected;
break;
}
}
else {
foreach ($original_params as $param => $value) {
$zenfolio_args[$param] = $value;
}
$keyring_fields = array('keyring', 'realmId', 'password');
foreach ($zenfolio_args as $param => $value) {
if (in_array($param, $keyring_fields)) {
unset($zenfolio_args[$param]);
}
}
if ($method === 'LoadPhotoSetPhotos') {
unset($zenfolio_args['level']);
unset($zenfolio_args['includePhotos']);
}
else if ($method === 'LoadPhotoSet') {
unset($zenfolio_args['startingIndex']);
unset($zenfolio_args['numberOfPhotos']);
}
$response = $this->make_call($method, $zenfolio_args, $keyring);
$this->pop_from_stack();
$this->push_to_stack('Processing response');
$ret .= $this->process_response($method, $response, $short_code);
$this->pop_from_stack();
}
}
$this->pop_from_stack();
return $ret;
}
/**
* Routing function that takes the response and redirects it to the appropriate processing function.
*
* @param $method
* @param $response
* @param array $short_code
* @return string
*/
function process_response($method, $response, &$short_code = array()) {
$header_display = $short_code['header_display'];
$level_2_meta = $short_code['level_2_meta'];
if (!empty($response->result)) {
$result = $response->result;
$ret = '';
switch ($method) {
case 'GetPopularPhotos':
case 'GetRecentPhotos':
case 'SearchPhotoByText':
case 'SearchPhotoByCategory':
$level_2_meta['total'] = $result->TotalCount;
$short_code['level_2_meta'] = $level_2_meta;
$ret = $this->process_photos($result, 'stream', $short_code);
break;
case 'LoadPhoto':
$ret = $this->process_photo($result, $short_code);
break;
case 'GetPopularSets':
case 'GetRecentSets':
case 'SearchSetByText':
case 'SearchSetByCategory':
$ret = $this->process_sets($result, $short_code);
break;
case 'LoadPhotoSet':
case 'LoadPhotoSetPhotos':
if (isset($result->ImageCount)) {
$level_2_meta['total'] = $result->ImageCount;
$short_code['level_2_meta'] = $level_2_meta;
}
$ret = $this->process_set($result, array('header_display' => $header_display), $short_code);
break;
case 'LoadGroupHierarchy':
$ret = $this->process_group_hierarchy($result, array('header_display' => $header_display), $short_code);
break;
case 'LoadGroup':
$ret = $this->process_group($result, array('header_display' => $header_display), $short_code, 0);
break;
}
return $ret;
}
else if ($response == $this->password_protected) {
return $response;
}
else if (!empty($response->error)) {
if (!empty($response->error->message)) {
return $this->error(esc_html__('Zenfolio returned an error:', 'photonic')."
\n".$response->error->message);
}
else {
return $this->error(esc_html__('Unknown error', 'photonic'));
}
}
else {
return $this->error(esc_html__('Unknown error', 'photonic'));
}
}
/**
* Takes an array of photos and displays each as a thumbnail. Each thumbnail, upon clicking launches a lightbox.
*
* @param $response
* @param string $parent
* @param array $short_code
* @return string
*/
function process_photos($response, $parent, $short_code = array()) {
if (!is_array($response)) {
if (empty($response->Photos) || !is_array($response->Photos)) {
return $this->error(esc_html__('Response is not an array', 'photonic'));
}
$response = $response->Photos;
}
global $photonic_zenfolio_photos_per_row_constraint, $photonic_zenfolio_photo_title_display, $photonic_zenfolio_photos_constrain_by_padding, $photonic_zenfolio_photos_constrain_by_count;
$ret = '';
$row_constraints = array('constraint-type' => $photonic_zenfolio_photos_per_row_constraint, 'padding' => $photonic_zenfolio_photos_constrain_by_padding, 'count' => $photonic_zenfolio_photos_constrain_by_count);
$photo_objects = $this->build_level_1_objects($response, $short_code);
$level_2_meta = $short_code['level_2_meta'];
$level_2_meta['end'] = $level_2_meta['start'] + count($response);
$ret .= $this->display_level_1_gallery($photo_objects,
array(
'title_position' => $photonic_zenfolio_photo_title_display,
'row_constraints' => $row_constraints,
'parent' => $parent,
'level_2_meta' => $level_2_meta,
),
$short_code
);
return $ret;
}
function build_level_1_objects($response, $short_code = array()) {
if (!is_array($response)) {
if (empty($response->Photos) || !is_array($response->Photos)) {
return array();
}
$response = $response->Photos;
}
$tile_size = (empty($short_code['tile_size']) || $short_code['tile_size'] == 'same') ? $short_code['main_size'] : $short_code['tile_size'];
$type = '$type';
$photo_objects = array();
$media = explode(',', $short_code['media']);
$videos_ok = in_array('videos', $media) || in_array('all', $media);
$photos_ok = in_array('photos', $media) || in_array('all', $media);
foreach ($response as $photo) {
if (empty($photo->$type) || $photo->$type != 'Photo' || ($photo->IsVideo && !$videos_ok) || (!$photo->IsVideo && !$photos_ok)) {
continue;
}
$appendage = array();
if (isset($photo->Sequence)) {
$appendage[] = 'sn='.$photo->Sequence;
}
if (isset($photo->UrlToken)) {
$appendage[] = 'tk='.$photo->UrlToken;
}
$photo_object = array();
$photo_object['thumbnail'] = 'https://'.$photo->UrlHost.$photo->UrlCore.'-'.$short_code['thumb_size'].'.jpg';
$photo_object['main_image'] = 'https://'.$photo->UrlHost.$photo->UrlCore.'-'.$short_code['main_size'].'.jpg';
$photo_object['tile_image'] = 'https://'.$photo->UrlHost.$photo->UrlCore.'-'.$tile_size.'.jpg';
if ($photo->IsVideo) {
$photo_object['video'] = substr($photo->OriginalUrl, 0, strlen($photo->OriginalUrl) - 7).$short_code['video_size'].'.mp4';
}
$photo_object['download'] = $photo_object['main_image'].'?'.implode('&', $appendage);
$photo_object['title'] = $photo->Title;
$photo_object['alt_title'] = $photo->Title;
$photo_object['description'] = $photo->Caption;
$photo_object['main_page'] = $photo->PageUrl;
$photo_object['id'] = $photo->Id;
$photo_object['provider'] = $this->provider;
$photo_object['gallery_index'] = $this->gallery_index;
$photo_objects[] = $photo_object;
}
return $photo_objects;
}
function build_level_2_objects($response, $short_code = array()) {
global $photonic_zenfolio_hide_password_protected_thumbnail;
$tile_size = (empty($short_code['tile_size']) || $short_code['tile_size'] == 'same') ? $short_code['main_size'] : $short_code['tile_size'];
$filter_list = array();
if (!empty($short_code['filter'])) {
$filter_list = explode(',', $short_code['filter']);
}
$objects = array();
foreach ($response as $photoset) {
if (empty($photoset->TitlePhoto)) {
continue;
}
if (!empty($photoset->AccessDescriptor) && !empty($photoset->AccessDescriptor->AccessType) && $photoset->AccessDescriptor->AccessType == 'Password' && !empty($photonic_zenfolio_hide_password_protected_thumbnail)) {
continue;
}
$object = array();
$photo = $photoset->TitlePhoto;
$object['id_1'] = $photoset->Id;
$object['thumbnail'] = 'https://'.$photo->UrlHost.$photo->UrlCore.'-'.$short_code['thumb_size'].'.jpg';
$object['tile_image'] = 'https://'.$photo->UrlHost.$photo->UrlCore.'-'.$tile_size.'.jpg';
$object['main_page'] = $photoset->PageUrl;
$object['title'] = esc_attr($photoset->Title);
$object['counter'] = $photoset->PhotoCount;
$object['data_attributes'] = array(
'thumb-size' => $short_code['thumb_size'],
'photo-count' => $short_code['photo_count'],
'photo-more' => empty($short_code['photo_more']) ? '' : $short_code['photo_more'],
'overlay-size' => $short_code['overlay_size'],
'overlay-video-size' => $short_code['overlay_video_size'],
);
if (!empty($photoset->AccessDescriptor) && !empty($photoset->AccessDescriptor->AccessType) && $photoset->AccessDescriptor->AccessType == 'Password') {
if (!in_array($photoset->AccessDescriptor->Id, $this->unlocked_realms)) {
$object['classes'] = array('photonic-zenfolio-passworded');
$object['passworded'] = 1;
$object['realm_id'] = $photoset->AccessDescriptor->Id;
$object['data_attributes']['realm'] = $photoset->AccessDescriptor->Id;
}
}
$page_url = parse_url($photoset->PageUrl);
$page_url = $page_url['path'];
$page_url = explode('/', $page_url);
if (count($page_url) > 1) {
$page_url = $page_url[1];
}
if (!is_array($page_url) && (count($filter_list) === 0 || (count($filter_list) > 0 && in_array($page_url, $filter_list) && strtolower($short_code['filter_type']) !== 'exclude') ||
(count($filter_list) > 0 && !in_array($page_url, $filter_list) && strtolower($short_code['filter_type']) === 'exclude'))) {
$objects[] = $object;
}
else if (is_array($page_url)) { // Something went wrong. Let's be safe and add the object.
$objects[] = $object;
}
}
return $objects;
}
/**
* Prints a single photo with the title as an and the caption as the image caption.
*
* @param $photo
* @param $short_code
* @return string
*/
function process_photo($photo, $short_code) {
$type = '$type';
if (empty($photo->$type) || $photo->$type != 'Photo') {
return '';
}
return $this->generate_single_photo_markup('zenfolio', array(
'src' => 'https://'.$photo->UrlHost.$photo->UrlCore.'-'.$short_code['main_size'].'.jpg',
'href' => $photo->PageUrl,
'title' => $photo->Title,
'caption' => $photo->Caption,
)
);
}
/**
* Takes an array of photosets and displays a thumbnail for each of them. Password-protected thumbnails might be excluded via the options.
*
* @param $response
* @param array $short_code
* @return string
*/
function process_sets($response, $short_code = array()) {
if (!is_array($response)) {
if (empty($response->PhotoSets) || !is_array($response->PhotoSets)) {
return $this->error(esc_html__('Response is not an array', 'photonic'));
}
$response = $response->PhotoSets;
}
global $photonic_zenfolio_sets_per_row_constraint, $photonic_zenfolio_sets_constrain_by_count, $photonic_zenfolio_sets_constrain_by_padding,
$photonic_zenfolio_set_title_display, $photonic_zenfolio_hide_set_photos_count_display;
$row_constraints = array('constraint-type' => $photonic_zenfolio_sets_per_row_constraint, 'padding' => $photonic_zenfolio_sets_constrain_by_padding, 'count' => $photonic_zenfolio_sets_constrain_by_count);
$objects = $this->build_level_2_objects($response, $short_code);
$ret = $this->display_level_2_gallery($objects,
array(
'row_constraints' => $row_constraints,
'type' => 'photosets',
'singular_type' => 'set',
'title_position' => $photonic_zenfolio_set_title_display,
'level_1_count_display' => $photonic_zenfolio_hide_set_photos_count_display,
),
$short_code
);
return $ret;
}
/**
* Displays a header with a basic summary for a photoset, along with thumbnails for all associated photos.
*
* @param $response
* @param array $options
* @param array $short_code
* @return string
*/
function process_set($response, $options = array(), &$short_code = array()) {
$ret = '';
$level_2_meta = $short_code['level_2_meta'];
$media = explode(',', $short_code['media']);
$videos_ok = in_array('videos', $media) || in_array('all', $media);
$photos_ok = in_array('photos', $media) || in_array('all', $media);
if (!is_array($response)) {
global $photonic_zenfolio_link_set_page, $photonic_zenfolio_hide_set_thumbnail, $photonic_zenfolio_hide_set_title, $photonic_zenfolio_hide_set_photo_count;
$header = $this->get_header_object($response, $short_code['thumb_size']);
$hidden = array('thumbnail' => !empty($photonic_zenfolio_hide_set_thumbnail), 'title' => !empty($photonic_zenfolio_hide_set_title), 'counter' => !empty($photonic_zenfolio_hide_set_photo_count));
$counters = array();
if ($photos_ok) $counters['photos'] = $response->ImageCount;
if ($videos_ok) $counters['videos'] = $response->VideoCount;
$level_2_meta['total'] = ($photos_ok ? $response->ImageCount : 0) + ($videos_ok ? $response->VideoCount : 0);
$short_code['level_2_meta'] = $level_2_meta;
$ret .= $this->process_object_header($header,
array(
'type' => 'set',
'hidden' => $this->get_hidden_headers($options['header_display'], $hidden),
'counters' => $counters,
'link' => empty($photonic_zenfolio_link_set_page),
'display' => $short_code['display'],
)
);
}
else {
$ret .= $this->process_photos($response, 'set', $short_code);
}
return $ret;
}
/**
* Takes a Zenfolio response object and converts it into an associative array with a title, a thumbnail URL and a link URL.
*
* @param $object
* @param $thumb_size
* @return array
*/
public function get_header_object($object, $thumb_size) {
$header = array();
if (!empty($object->Title)) {
$header['title'] = $object->Title;
if (!empty($object->TitlePhoto)) {
$photo = $object->TitlePhoto;
$header['thumb_url'] = 'https://' . $photo->UrlHost . $photo->UrlCore . '-' . $thumb_size . '.jpg';
}
$header['link_url'] = $object->PageUrl;
}
return $header;
}
/**
* For a given user this prints out the group hierarchy. This starts with the root level and first prints all immediate
* children photosets. It then goes into each child group and recursively displays the photosets for each of them in separate sections.
*
* @param $response
* @param array $options
* @param array $short_code
* @return string
*/
function process_group_hierarchy($response, $options = array(), $short_code = array()) {
if (empty($response->Elements)) {
return $this->error(esc_html__('No galleries, collections or groups defined for this user', 'photonic'));
}
$filters = array();
if (!empty($short_code['kind']) && in_array(strtolower($short_code['kind']), array('popular', 'recent')) && !empty($short_code['login_name']) && empty($short_code['filter'])) {
$pr_response = $this->make_wp_call('LoadPublicProfile', array('login_name' => $short_code['login_name']));
if (!empty($pr_response->result)) {
$pr_response = $pr_response->result;
if (strtolower($short_code['kind']) == 'popular' && !empty($pr_response->FeaturedPhotoSets)) {
foreach ($pr_response->FeaturedPhotoSets as $photoset) {
$filters[] = $photoset->Id;
}
}
else if (strtolower($short_code['kind']) == 'recent' && !empty($pr_response->RecentPhotoSets)) {
foreach ($pr_response->RecentPhotoSets as $photoset) {
$filters[] = $photoset->Id;
}
}
if (empty($filters)) {
return '';
}
}
}
$all_photosets = array();
$ret = $this->process_group($response, $options, $short_code, 0, $all_photosets, $filters);
return $ret;
}
/**
* For a given group this displays the immediate children photosets and then recursively displays all children groups.
*
* @param $group
* @param array $options
* @param array $short_code
* @param $level
* @param array $all_photosets
* @param array $recent_popular
* @return string
*/
function process_group($group, $options, $short_code, $level, &$all_photosets = array(), $recent_popular = array()) {
$ret = '';
$type = '$type';
if (!isset($group->Elements)) {
$object_id = $group->Id;
$method = 'LoadGroup';
if(($f = stripos($object_id, 'f')) !== false) {
$object_id = substr($object_id, $f + 1);
}
$params = array();
$params['groupId'] = $object_id;
$params['level'] = 'Full';
$params['includeChildren'] = true;
$response = $this->make_call($method, $params);
if (!empty($response->result)) {
$group = $response->result;
}
}
if (empty($group->Elements)) {
return '';
}
$elements = $group->Elements;
$photosets = array();
$groups = array();
global $photonic_zenfolio_hide_password_protected_thumbnail;
$image_count = 0;
$requests = array();
foreach ($elements as $element) {
if ($element->$type == 'PhotoSet') {
if (!empty($short_code['photoset_type']) && in_array(strtolower($short_code['photoset_type']), array('gallery', 'collection')) && $short_code['photoset_type'] !== $element->Type) {
continue;
}
if (!empty($element->AccessDescriptor) && !empty($element->AccessDescriptor->AccessType) && $element->AccessDescriptor->AccessType == 'Password' && !empty($photonic_zenfolio_hide_password_protected_thumbnail)) {
continue;
}
if (!empty($short_code['user_specific_category']) || !empty($short_code['user_specific_text'])) {
// Need an extra call here, since the LoadGroup doesn't return Level2 attributes for the children
// Calls are slow, so we make all of them together at the end of this instead of calling the API individually
$params = array();
$params['photosetId'] = $element->Id;
$params['level'] = 'Level2';
$params['includePhotos'] = false;
$method = 'LoadPhotoSet';
$request = $this->prepare_request($method, $params);
$requests[] = array(
'url' => $this->secure_url,
'type' => 'POST',
'headers' => $request['headers'],
'data' => $request['body'],
);
}
$photosets[$element->Id] = $element;
$image_count += $element->ImageCount;
}
else if ($element->$type == 'Group') {
$groups[] = $element;
}
}
if (!empty($requests)) {
$responses = Requests::request_multiple($requests);
foreach ($responses as $ps_response) {
if (is_a($ps_response, 'Requests_Response')) {
$found = false;
$ps_response = json_decode($ps_response->body);
if (!empty($ps_response->result)) {
$ps_response = $ps_response->result;
if (empty($ps_response->Categories) && !empty($short_code['user_specific_category'])) {
$found = false;
}
else if (!empty($short_code['user_specific_category'])) {
$categories = $ps_response->Categories;
foreach ($categories as $category) {
if ($category == $short_code['category_code']) {
$found = true;
}
}
}
if (!$found) {
if (!empty($short_code['user_specific_text'])) {
// Check Title, Caption, Keywords
$text = $short_code['text'];
$text = explode(',', $text);
$text = array_map('trim', $text);
$to_match = array();
foreach ($text as $item) {
$to_match[] = '\b'.$item.'\b';
}
$to_match = '/('.implode('|', $to_match).')/i';
$keywords = implode(',', $ps_response->Keywords);
$found = preg_match($to_match, $ps_response->Title) || preg_match($to_match, $ps_response->Caption) || preg_match($to_match, $keywords);
}
}
if (!$found) {
unset($photosets[$ps_response->Id]);
}
}
}
}
}
if (!empty($recent_popular)) {
foreach ($photosets as $id => $set) {
if (!in_array($id, $recent_popular)) {
unset($photosets[$id]);
}
}
}
$all_photosets = array_merge($all_photosets, array_values($photosets));
global $photonic_zenfolio_hide_empty_groups;
global $photonic_zenfolio_link_group_page, $photonic_zenfolio_hide_group_title, $photonic_zenfolio_hide_group_photo_count, $photonic_zenfolio_hide_group_group_count, $photonic_zenfolio_hide_group_set_count;
$hidden = array(
'thumbnail' => true,
'title' => !empty($photonic_zenfolio_hide_group_title),
'counter' => !(empty($photonic_zenfolio_hide_group_photo_count) || empty($photonic_zenfolio_hide_group_group_count) || empty($photonic_zenfolio_hide_group_set_count)),
);
if (!empty($group->Title) && ($image_count > 0 || empty($photonic_zenfolio_hide_empty_groups))) {
$header = $this->get_header_object($group, $short_code['thumb_size']);
$counters = array(
'sets' => empty($photonic_zenfolio_hide_group_set_count) ? count($photosets) : 0,
'groups' => empty($photonic_zenfolio_hide_group_group_count) ? count($groups) : 0,
'photos' => empty($photonic_zenfolio_hide_group_photo_count)? $image_count : 0,
);
if ($short_code['structure'] !== 'flat') {
$ret .= $this->process_object_header($header,
array(
'type' => 'set',
'hidden' => $this->get_hidden_headers($options['header_display'], $hidden),
'counters' => $counters,
'link' => empty($photonic_zenfolio_link_group_page),
'display' => $short_code['display'],
)
);
}
}
if ($short_code['structure'] !== 'flat') {
$ret .= $this->process_sets($photosets, $short_code);
}
foreach ($groups as $group) {
$out = $this->process_group($group, $options, $short_code, $level + 1, $all_photosets, $recent_popular);
if ($short_code['structure'] !== 'flat') {
$ret .= $out;
}
}
if ($short_code['structure'] === 'flat' && $level === 0) {
if (!empty($header)) {
$counters = array(
'sets' => empty($photonic_zenfolio_hide_group_set_count) ? count($all_photosets) : 0,
);
$ret .= $this->process_object_header($header,
array(
'type' => 'set',
'hidden' => $this->get_hidden_headers($options['header_display'], $hidden),
'counters' => $counters,
'link' => empty($photonic_zenfolio_link_group_page),
'display' => $short_code['display'],
)
);
}
$ret .= $this->process_sets($all_photosets, $short_code);
}
return $ret;
}
function authenticate($password) {
global $photonic_zenfolio_default_user;
$photonic_authentication = get_option('photonic_authentication');
if (!isset($photonic_authentication['zenfolio'])) {
$photonic_authentication['zenfolio'] = array();
}
$ret = array();
if (!empty($photonic_zenfolio_default_user)) {
$challenge_response = $this->make_call('GetChallenge', array('loginName' => $photonic_zenfolio_default_user));
if (!empty($challenge_response)) {
$salt = $challenge_response->result->PasswordSalt;
$salt = call_user_func_array('pack', array_merge(array('C*'), $salt));
$pass_hash = hash('sha256', $salt.utf8_encode($password), true);
$challenge = $challenge_response->result->Challenge;
$this->perform_back_end_authentication($pass_hash, $challenge);
if (empty($this->token)) {
$ret['error'] = esc_html__('Authentication failed.', 'photonic');
unset($photonic_authentication['zenfolio']['pass_hash']);
}
else {
$photonic_authentication['zenfolio']['pass_hash'] = unpack('C*', $pass_hash);
$ret['success'] = $this->token;
}
}
else {
$ret['error'] = esc_html__('Failed to get challenge.', 'photonic');
}
}
else {
unset($photonic_authentication['zenfolio']['pass_hash']);
$ret['error'] = sprintf(esc_html__('Default user not defined. Please define one under %s', 'photonic'), 'Photonic → Settings → Zenfolio → Zenfolio Photo Settings → Default User');
}
update_option('photonic_authentication', $photonic_authentication);
return $ret;
}
function perform_back_end_authentication($pass_hash = '', $challenge = false) {
global $photonic_zenfolio_default_user;
if (!empty($photonic_zenfolio_default_user)) {
$photonic_authentication = get_option('photonic_authentication');
$auth_done = !empty($photonic_authentication) && !empty($photonic_authentication['zenfolio']) && !empty($photonic_authentication['zenfolio']['pass_hash']);
if ($auth_done || !empty($pass_hash)) {
if (empty($pass_hash)) {
$pass_hash = $photonic_authentication['zenfolio']['pass_hash'];
$pass_hash = call_user_func_array('pack', array_merge(array('C*'), $pass_hash));
}
if (empty($challenge)) {
$challenge_response = $this->make_call('GetChallenge', array('loginName' => $photonic_zenfolio_default_user));
$challenge = $challenge_response->result->Challenge;
}
$challenge_pack = call_user_func_array('pack', array_merge(array('C*'), $challenge));
$challenge_hash = hash('sha256', $challenge_pack.$pass_hash, true);
$proof = array_values(unpack('C*', $challenge_hash));
$auth_response = $this->make_call('Authenticate', array('challenge' => $challenge, 'proof' => $proof));
if (!empty($auth_response->result)) {
$this->token = $auth_response->result;
return;
}
}
}
$this->token = false;
}
/**
* @param $method
* @param $params
* @param $keyring
* @return array
*/
function prepare_request($method, $params, $keyring = null) {
$request = array();
$request['method'] = $method;
$request['params'] = array_values($params);
$request['id'] = 1;
$bodyString = json_encode($request);
$bodyLength = strlen($bodyString);
$headers = array();
$headers['Host'] = 'api.zenfolio.com';
$headers['User-Agent'] = $this->user_agent;
if ($this->token && $method !== 'GetChallenge' && $method !== 'Authenticate') {
$headers['X-Zenfolio-Token'] = $this->token;
}
if (isset($_COOKIE['photonic-zf-keyring'])) {
$headers['X-Zenfolio-Token'] = $_COOKIE['photonic-zf-keyring'];
}
else if (!empty($keyring)) {
$headers['X-Zenfolio-Keyring'] = $keyring;
}
$headers['Content-Type'] = 'application/json';
$headers['Content-Length'] = $bodyLength;
return array('headers' => $headers, 'body' => $bodyString);
}
/**
* @param $method
* @param $ssl_verify_peer
* @param $request
* @return array|mixed|null|object|string|string[]|WP_Error
*/
public function make_wp_request($method, $ssl_verify_peer, $request) {
$curl_args = array(
'user-agent' => $this->user_agent,
'sslverify' => $ssl_verify_peer,
'timeout' => 30,
'headers' => $request['headers'],
'method' => 'POST',
'body' => $request['body'],
);
$response = wp_remote_request($this->secure_url, $curl_args);
$response = wp_remote_retrieve_body($response);
//PHP/WP's json_decode() function really messes up the "long" ids returned by Zenfolio. The following takes care of this.
// Can't pass the 4th argument as outlined here: https://php.net/manual/en/function.json-decode.php, since it only came into existence in PHP 5.4
$response = preg_replace('/"Id":(\d+)/', '"Id":"$1"', $response);
$response = preg_replace('/"RealmId":(\d+)/', '"Id":"$1"', $response);
if ($method == 'KeyringGetUnlockedRealms') {
$realm_ids = array();
preg_match('/([\[^,\d]+\])/', $response, $realm_ids);
if (!empty($realm_ids)) {
$realm_ids = $realm_ids[0];
$replace = $realm_ids;
$replace = str_replace('[', '["', $replace);
$replace = str_replace(']', '"]', $replace);
$replace = str_replace(',', '","', $replace);
$response = str_replace($realm_ids, $replace, $response);
}
}
$response = json_decode($response);
return $response;
}
}
```