<?php

  /**
   * Copyright (c) 2014 Vincent Petry <pvince81@owncloud.com>
   * This file is licensed under the Affero General Public License version 3 or
   * later.
   * See the COPYING-README file.
   */

  namespace OCA\Files;

  /**
   * Helper class for manipulating file information
   */

  class Helper
  {
  	public static function buildFileStorageStatistics($dir) {

  		// information about storage capacities
  		$storageInfo = \OC_Helper::getStorageInfo($dir);

  		$l = new \OC_L10N('files');
  		$maxUploadFileSize = \OCP\Util::maxUploadFilesize($dir, $storageInfo['free']);
  		$maxHumanFileSize = \OCP\Util::humanFileSize($maxUploadFileSize);
  		$maxHumanFileSize = $l->t('Upload (max. %s)', array($maxHumanFileSize));
  
  		return array('uploadMaxFilesize' => $maxUploadFileSize,
  					 'maxHumanFilesize'  => $maxHumanFileSize,
  					 'freeSpace' => $storageInfo['free'],

  					 'usedSpacePercent'  => (int)$storageInfo['relative']);
  	}

  	/**
  	 * Determine icon for a given file
  	 *
  	 * @param \OC\Files\FileInfo $file file info
  	 * @return string icon URL
  	 */

  	public static function determineIcon($file) {
  		if($file['type'] === 'dir') {

  			$icon = \OC_Helper::mimetypeIcon('dir');
  			// TODO: move this part to the client side, using mountType
  			if ($file->isShared()) {
  				$icon = \OC_Helper::mimetypeIcon('dir-shared');
  			} elseif ($file->isMounted()) {
  				$icon = \OC_Helper::mimetypeIcon('dir-external');

  			}

  		}else{
  			$icon = \OC_Helper::mimetypeIcon($file->getMimetype());

  		}

  		return substr($icon, 0, -3) . 'svg';

  	}
  
  	/**
  	 * Comparator function to sort files alphabetically and have
  	 * the directories appear first

  	 *
  	 * @param \OCP\Files\FileInfo $a file
  	 * @param \OCP\Files\FileInfo $b file
  	 * @return int -1 if $a must come before $b, 1 otherwise

  	 */

  	public static function compareFileNames($a, $b) {
  		$aType = $a->getType();
  		$bType = $b->getType();
  		if ($aType === 'dir' and $bType !== 'dir') {

  			return -1;

  		} elseif ($aType !== 'dir' and $bType === 'dir') {

  			return 1;
  		} else {

  			return strnatcasecmp($a->getName(), $b->getName());

  		}
  	}
  
  	/**

  	 * Comparator function to sort files by date
  	 *
  	 * @param \OCP\Files\FileInfo $a file
  	 * @param \OCP\Files\FileInfo $b file
  	 * @return int -1 if $a must come before $b, 1 otherwise

  	 */

  	public static function compareTimestamp($a, $b) {
  		$aTime = $a->getMTime();
  		$bTime = $b->getMTime();
  		return $aTime - $bTime;
  	}
  
  	/**
  	 * Comparator function to sort files by size
  	 *
  	 * @param \OCP\Files\FileInfo $a file
  	 * @param \OCP\Files\FileInfo $b file
  	 * @return int -1 if $a must come before $b, 1 otherwise
  	 */
  	public static function compareSize($a, $b) {
  		$aSize = $a->getSize();
  		$bSize = $b->getSize();
  		return $aSize - $bSize;
  	}
  
  	/**
  	 * Formats the file info to be returned as JSON to the client.
  	 *
  	 * @param \OCP\Files\FileInfo $i
  	 * @return array formatted file info
  	 */
  	public static function formatFileInfo($i) {
  		$entry = array();

  		$entry['id'] = $i['fileid'];
  		$entry['parentId'] = $i['parent'];
  		$entry['date'] = \OCP\Util::formatDate($i['mtime']);
  		$entry['mtime'] = $i['mtime'] * 1000;
  		// only pick out the needed attributes
  		$entry['icon'] = \OCA\Files\Helper::determineIcon($i);
  		if (\OC::$server->getPreviewManager()->isMimeSupported($i['mimetype'])) {
  			$entry['isPreviewAvailable'] = true;
  		}
  		$entry['name'] = $i->getName();
  		$entry['permissions'] = $i['permissions'];
  		$entry['mimetype'] = $i['mimetype'];
  		$entry['size'] = $i['size'];
  		$entry['type'] = $i['type'];
  		$entry['etag'] = $i['etag'];
  		if (isset($i['displayname_owner'])) {
  			$entry['shareOwner'] = $i['displayname_owner'];
  		}
  		if (isset($i['is_share_mount_point'])) {
  			$entry['isShareMountPoint'] = $i['is_share_mount_point'];
  		}
  		$mountType = null;
  		if ($i->isShared()) {
  			$mountType = 'shared';
  		} else if ($i->isMounted()) {
  			$mountType = 'external';
  		}
  		if ($mountType !== null) {
  			if ($i->getInternalPath() === '') {
  				$mountType .= '-root';

  			}

  			$entry['mountType'] = $mountType;

  		}

  		return $entry;
  	}

  	/**
  	 * Format file info for JSON
  	 * @param \OCP\Files\FileInfo[] $fileInfos file infos
  	 */
  	public static function formatFileInfos($fileInfos) {
  		$files = array();
  		foreach ($fileInfos as $i) {
  			$files[] = self::formatFileInfo($i);
  		}

  
  		return $files;
  	}
  
  	/**

  	 * Retrieves the contents of the given directory and
  	 * returns it as a sorted array of FileInfo.
  	 *
  	 * @param string $dir path to the directory
  	 * @param string $sortAttribute attribute to sort on
  	 * @param bool $sortDescending true for descending sort, false otherwise
  	 * @return \OCP\Files\FileInfo[] files

  	 */

  	public static function getFiles($dir, $sortAttribute = 'name', $sortDescending = false) {
  		$content = \OC\Files\Filesystem::getDirectoryContent($dir);
  
  		return self::sortFiles($content, $sortAttribute, $sortDescending);

  	}
  
  	/**

  	 * Sort the given file info array
  	 *
  	 * @param \OCP\Files\FileInfo[] $files files to sort
  	 * @param string $sortAttribute attribute to sort on
  	 * @param bool $sortDescending true for descending sort, false otherwise
  	 * @return \OCP\Files\FileInfo[] sorted files

  	 */

  	public static function sortFiles($files, $sortAttribute = 'name', $sortDescending = false) {
  		$sortFunc = 'compareFileNames';
  		if ($sortAttribute === 'mtime') {
  			$sortFunc = 'compareTimestamp';
  		} else if ($sortAttribute === 'size') {
  			$sortFunc = 'compareSize';

  		}

  		usort($files, array('\OCA\Files\Helper', $sortFunc));
  		if ($sortDescending) {
  			$files = array_reverse($files);

  		}

  		return $files;

  	}

  }