<?php
/*
 * Copyright (c) 2025, Tribal Limited
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of Zenario, Tribal Limited nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL TRIBAL LTD BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
if (!defined('NOT_ACCESSED_DIRECTLY')) exit('This file may not be directly accessed');


class zenario_common_features__admin_boxes__document_properties extends ze\moduleBaseClass {
	
	public function fillAdminBox($path, $settingGroup, &$box, &$fields, &$values) {
		if (!ze\module::isRunning('zenario_extranet')) {
			$fields['details/privacy']['values']['private']['disabled'] = true;
		}
		
		if ($documentId = $box['key']['id']) {
			$documentTagsString = '';

			$documentDetails = ze\row::get('documents', ['chain_id', 'file_id', 'thumbnail_id', 'extract', 'extract_wordcount', 'title', 'filename', 'folder_name', 'privacy'],  $documentId);
			$documentName = $documentDetails['filename'];
			$box['title'] = ze\admin::phrase('Editing metadata for document "[[filename]]"', ["filename" => $documentName]);
			
			$values['details/document_title'] = $documentDetails['title'];
			$extension = pathinfo($documentName, PATHINFO_EXTENSION);
			$values['details/document_extension'] = $extension;
			$values['details/document_name'] = pathinfo($documentName, PATHINFO_FILENAME);
			$fields['details/document_name']['post_field_html'] = '&nbsp;.' . $extension;
			$fileDatetime = ze\row::get('documents', 'file_datetime', ['type' => 'file','id' => $documentId]);
			$values['details/date_uploaded'] = $fileDatetime;
			
			if (ze::setting('enable_document_tags')) {
				$documentTags = ze\row::getValues('document_tag_link', 'tag_id', ['document_id' => $documentId]);
				foreach ($documentTags as $tag) {
					$documentTagsString .= $tag . ",";
				}
				$values['details/tags'] = $documentTagsString;
				$fields['details/link_to_add_tags']['snippet']['html'] = 
						ze\admin::phrase('To add or edit document tags click <a[[link]]>this link</a>.',
							['link' => ' href="'. htmlspecialchars(ze\link::absolute(). 'organizer.php#zenario__library/panels/document_tags'). '" target="_blank"']);
			} else {
				$fields['details/tags']['hidden'] = true;
			}
			
			$values['extract/extract_wordcount'] = $documentDetails['extract_wordcount'];
			$values['extract/extract'] = ($documentDetails['extract'] ? $documentDetails['extract']: 'No plain-text extract');

			$fileInfo = ze\row::get('files', ['mime_type', 'short_checksum', 'location', 'path'], $documentDetails['file_id']);
			
			// Add a preview image for JPEG/PNG/GIF images 
			if (!empty($documentDetails['thumbnail_id'])) {
				
				unset($fields['upload_image/thumbnail_image']['snippet']);
				$width = $height = $url = false;
				\ze\image::retinaLink($width, $height, $url, $documentDetails['thumbnail_id'], $widthLimit = 700, $heightLimit = 200);
				$fields['upload_image/thumbnail_image']['image'] = [
					'width' => $width,
					'height' => $height,
					'url' => $url
				];
			
			} else {
				$fields['upload_image/delete_thumbnail_image']['hidden'] = true;
				$mimeType = $fileInfo['mime_type'];
				if ($mimeType == 'image/gif' || $mimeType == 'image/png' || $mimeType == 'image/jpeg' || $mimeType == 'image/webp' || $mimeType == 'image/pjpeg') {
					
					unset($fields['upload_image/thumbnail_image']['snippet']);
					$width = $height = $url = false;
					\ze\image::retinaLink($width, $height, $url, $documentDetails['file_id'], $widthLimit = 700, $heightLimit = 200);
					$fields['upload_image/thumbnail_image']['image'] = [
						'width' => $width,
						'height' => $height,
						'url' => $url
					];
				
				} else {
					unset($fields['upload_image/thumbnail_image']['image']);
					$fields['upload_image/thumbnail_image']['snippet'] = ['html' => ze\admin::phrase('No thumbnail available')];
				}
			}
			
			//Get privacy settings
			$values['details/privacy'] = $documentDetails['privacy'];
			
			//Get short checksum
			$values['details/checksum'] = $fileInfo['short_checksum'];
			
			$box['identifier']['value'] = ze\admin::phrase('Document ID [[id]], checksum "[[checksum]]"', ['id' => $documentId, 'checksum' => $values['details/checksum']]);

			//Location (DB, docstore, s3)
			$storageString = "Stored in the [[storage_location]]";
			if ($fileInfo['location'] == 'docstore') {
				$storageString .= ", folder name [[folder_name]].";
			} else {
				$storageString .= ".";
			}

			$fields['details/document_name']['note_below'] = ze\admin::phrase($storageString, ['storage_location' => $fileInfo['location'], 'folder_name' => $fileInfo['path']]);
			
			
			//If this document is in a chain, show all of the chained documents
			if ($chainId = $documentDetails['chain_id']) {
				
				$sql = "
					SELECT id
					FROM ". DB_PREFIX. "documents
					WHERE chain_id = ". (int) $chainId. "
					  AND id != ". (int) $documentId. "
					ORDER BY id";
				
				$chainedIds = ze\sql::fetchValues($sql);
				$values['details/chain_ids'] = implode(',', $chainedIds);
				$values['details/in_chain'] = 1;
				$fields['details/in_chain']['label'] = ze\admin::nphrase('This document is linked to another document', 'This document is linked to [[count]] other documents', count($chainedIds));
			
			//Otherwise we'll need to show a picker to select a document to link to
			} else {
				//Don't let the UI allow the admin to select the current document to link to
				$fields['details/chain_id']['pick_items']['disabled_if_for_all_selected_items'] .= ' || item.id == '. (int) $documentId;
				
				$fields['details/chain_id']['tooltip'] =
					ze\admin::phrase('Select a document here to link "[[filename]]" to the selected document. To link multiple documents together in the same chain, select a document that\'s already linked.',
						$documentDetails);
			}
		}
	}
	
	public function formatAdminBox($path, $settingGroup, &$box, &$fields, &$values, $changes) {
		if (!empty($fields['upload_image/delete_thumbnail_image']['pressed'])) {
			unset($fields['upload_image/thumbnail_image']['image']);
			$fields['upload_image/thumbnail_image']['snippet'] = ['html' => ze\admin::phrase('No thumbnail available')];
			$box['key']['delete_thumbnail'] = true;
		}
	}
	
	public function validateAdminBox($path, $settingGroup, &$box, &$fields, &$values, $changes, $saving) {
		$documentId = $box['key']['id'];
		$parentfolderId=ze\row::get('documents', 'folder_id', ['id' => $documentId]);
		$newDocumentName = trim($values['details/document_name']);
		
		if (!$newDocumentName ){
			$box['tabs']['details']['errors'][] = ze\admin::phrase('Please enter a filename.');
		} else {
			// Stop spaces and illegal characters being used in filenames
			if ($newDocumentName !== ze\file::safeName($newDocumentName)) {
				$box['tabs']['details']['errors'][] = ze\admin::phrase('Your filename cannot contain any of the following characters: /, \\, :, ;, *, ?, ", <, > or |');
			}
		}
		
		$sql =  "
			SELECT id
			FROM ".DB_PREFIX."documents
			WHERE type = 'file' 
			AND folder_id = ". (int) $parentfolderId. "
			AND filename = '". ze\escape::sql($newDocumentName). "' 
			AND id != ". (int) $documentId;
		
		$documentIdList = [];
		$result = ze\sql::select($sql);
		while($row = ze\sql::fetchAssoc($result)) {
				$documentIdList[] = $row;
		}
		$numberOfIds = count($documentIdList);
		
		if ($numberOfIds > 0){
			$box['tabs']['details']['errors'][] = ze\admin::phrase('The filename “[[folder_name]]” is already taken. Please choose a different name.', ['folder_name' => $newDocumentName]);
		}
	}
	
	public function saveAdminBox($path, $settingGroup, &$box, &$fields, &$values, $changes) {
		$documentId = $box['key']['id'];
		$documentTitle = $values['details/document_title'];
		$documentPrivacy = $values['details/privacy'];
		
		$document = ze\row::get('documents', ['filename', 'file_id', 'title', 'id', 'privacy'], ['id' => $documentId]);
		$file = ze\row::get('files', ['id', 'filename', 'path', 'created_datetime', 'short_checksum'], $document['file_id']);
		
		$oldDocumentName = $document['filename'];
		if ($documentId) {
			$documentName = trim($values['details/document_name']) . '.' . trim($values['details/document_extension']);
		} else {
			$documentName = trim($values['details/document_name']);
		}
		
		//Rename public files directory and update filename if different
		if ($oldDocumentName != $documentName) {
			$symFolder =  CMS_ROOT . 'public/downloads/' . $file['short_checksum'];
			$oldSymPath = $symFolder . '/' . $oldDocumentName;
			$newSymPath = $symFolder . '/' . $documentName;
			if(!ze\server::isWindows() && is_link($oldSymPath)) {
				rename($oldSymPath, $newSymPath);
			}
			
			//Documents with the same file must have the same filename for now or the public link would break.
			ze\row::update('documents', ['filename' => $documentName], ['id' => $document['id']]);
			
			//Update any htaccess files to redirect to the new path
			ze\document::remakeRedirectHtaccessFiles($documentId);
			
			//Check if there are any other documents with the old name, and regenerate their links if necessary
			$otherDocsWithOldName = ze\row::getArray('documents', 'id', ['file_id' => $document['file_id'], 'privacy' => 'public']);
			if (isset($otherDocsWithOldName)) {
				foreach ($otherDocsWithOldName as $docWithOldName) {
					ze\document::generatePublicLink($docWithOldName);
				}
			}
		}
		
		if ($document['title'] != $documentTitle) {
			ze\row::update('documents', ['title' => $documentTitle], $documentId);
		}
		
		//Save document thumbnail image
		$old_image = ze\row::getValues('documents', 'thumbnail_id', $documentId);
		$new_image = $values['zenario_common_feature__upload'];
		
		if ($new_image) {
			if (!in_array($new_image, $old_image)) {
				if ($path = ze\file::getPathOfUploadInCacheDir($new_image)) {
					$fileId = ze\fileAdm::addToDatabase(
						'hierarchical_file_thumbnail', $path, $filename = false,
						$mustBeAnImage = false, $deleteWhenDone = true, $addToDocstoreDirIfPossible = true,
						$imageAltTag = false, $imageTitle = false, $imagePopoutTitle = false, $imageMimeType = false, $imageCredit = '',
						//Hierarchical document thumbnails must always be public, regardless of the default privacy setting
						$setPrivacy = 'public'
						
					);
					$fileDetails = [];
					$fileDetails['thumbnail_id'] = $fileId;
					//update thumbnail
					ze\row::set('documents', $fileDetails, $documentId);
				}
			}
		} elseif ($box['key']['delete_thumbnail']) {
			ze\row::update('documents', ['thumbnail_id' => 0], $documentId);
		}
		
		//If the thumbnail was replaced with a different one, remove the old one if it is no longer used.
		if ($old_image && ($new_image || $box['key']['delete_thumbnail'])) {
			$oldImageId = $old_image[$box['key']['id']];
			
			$sql = "
				SELECT COUNT(*)
				FROM " . DB_PREFIX . "documents
				WHERE id != " . (int) $box['key']['id'] . "
				AND thumbnail_id = " . (int) $oldImageId;
			$result = ze\sql::select($sql);
			$count = ze\sql::fetchValue($result);
			
			if (!$count) {
				ze\row::delete('files', ['id' => $oldImageId, 'usage' => 'hierarchical_file_thumbnail']);
			}
		}
	
		//Save document tags
		ze\row::delete('document_tag_link', ['document_id' => $documentId]);
		$tagIds = ze\ray::explodeAndTrim($values['details/tags']);
		foreach ($tagIds as $tagId) {
			ze\row::set('document_tag_link', 
				['tag_id' => $tagId, 'document_id' => $documentId], 
				['tag_id' => $tagId, 'document_id' => $documentId]);
		}
		
		//Update document privacy settings
		ze\row::update('documents', ['privacy' => $documentPrivacy], ['id' => $documentId]);
		
		//Generate public link if the document is public...
		if ($documentPrivacy == 'public') {
			ze\document::generatePublicLink($documentId);
		//... or delete public link if the document is private or offline.
		} else {
			ze\document::deletePublicLink($documentId, $documentDeleted = false, $documentPrivacy);
		}
		
		if ($values['details/add_to_chain'] && ($chainId = $values['details/chain_id'])) {
			ze\document::updateChain([$documentId, $chainId], true);
		
		} elseif (!$values['details/in_chain']) {
			ze\document::removeFromChain($documentId);
		}
	}
	
}
