Skip to content

Commit

Permalink
fix(files): Make sure to add the fileid on favorite folders navigat…
Browse files Browse the repository at this point in the history
…ion entries

Signed-off-by: Ferdinand Thiessen <[email protected]>
  • Loading branch information
susnux committed Jan 21, 2024
1 parent 02cc1b4 commit 98e6568
Show file tree
Hide file tree
Showing 4 changed files with 63 additions and 32 deletions.
63 changes: 41 additions & 22 deletions apps/files/lib/Activity/Helper.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
*
* @author Christoph Wurst <[email protected]>
* @author Joas Schilling <[email protected]>
* @author Ferdinand Thiessen <[email protected]>
*
* @license AGPL-3.0
*
Expand All @@ -23,30 +24,29 @@
namespace OCA\Files\Activity;

use OCP\Files\Folder;
use OCP\Files\IRootFolder;
use OCP\Files\Node;
use OCP\ITagManager;

class Helper {
/** If a user has a lot of favorites the query might get too slow and long */
public const FAVORITE_LIMIT = 50;

/** @var ITagManager */
protected $tagManager;

/**
* @param ITagManager $tagManager
*/
public function __construct(ITagManager $tagManager) {
$this->tagManager = $tagManager;
public function __construct(
protected ITagManager $tagManager,
protected IRootFolder $rootFolder,
) {
}

/**
* Returns an array with the favorites
* Return an array with nodes marked as favorites
*
* @param string $user
* @return array
* @param string $user User ID
* @param bool $foldersOnly Only return folders (default false)
* @return Node[]
* @throws \RuntimeException when too many or no favorites where found
*/
public function getFavoriteFilePaths($user) {
public function getFavoriteNodes(string $user, bool $foldersOnly = false): array {
$tags = $this->tagManager->load('files', [], false, $user);
$favorites = $tags->getFavorites();

Expand All @@ -57,26 +57,45 @@ public function getFavoriteFilePaths($user) {
}

// Can not DI because the user is not known on instantiation
$rootFolder = \OC::$server->getUserFolder($user);
$folders = $items = [];
$userFolder = $this->rootFolder->getUserFolder($user);
$nodes = [];
foreach ($favorites as $favorite) {
$nodes = $rootFolder->getById($favorite);
$nodes = $userFolder->getById($favorite);
if (!empty($nodes)) {
/** @var \OCP\Files\Node $node */
$node = array_shift($nodes);
$path = substr($node->getPath(), strlen($user . '/files/'));

$items[] = $path;
if ($node instanceof Folder) {
$folders[] = $path;
if (!$foldersOnly || $node instanceof Folder) {
$nodes[] = $node;
}
}
}

if (empty($items)) {
if (empty($nodes)) {
throw new \RuntimeException('No favorites', 1);
}

return $nodes;
}

/**
* Returns an array with the favorites
*
* @param string $user
* @return array
* @throws \RuntimeException when too many or no favorites where found
*/
public function getFavoriteFilePaths($user) {
$userFolder = $this->rootFolder->getUserFolder($user);
$nodes = $this->getFavoriteNodes($user);
$folders = $items = [];
foreach ($nodes as $node) {
$path = $userFolder->getRelativePath($node->getPath());

$items[] = $path;
if ($node instanceof Folder) {
$folders[] = $path;
}
}

return [
'items' => $items,
'folders' => $folders,
Expand Down
11 changes: 8 additions & 3 deletions apps/files/lib/Controller/ViewController.php
Original file line number Diff line number Diff line change
Expand Up @@ -226,9 +226,14 @@ public function index($dir = '', $view = '', $fileid = null, $fileNotFound = fal

// Get all the user favorites to create a submenu
try {
$favElements = $this->activityHelper->getFavoriteFilePaths($userId);
$userFolder = $this->rootFolder->getUserFolder($this->userSession->getUser()->getUID());

Check notice

Code scanning / Psalm

PossiblyNullReference Note

Cannot call method getUID on possibly null value
$favElements = $this->activityHelper->getFavoriteNodes($userId, true);
$favElements = array_map(fn (Folder $node) => [
'fileid' => $node->getId(),
'path' => $userFolder->getRelativePath($node->getPath()),
], $favElements);

Check notice

Code scanning / Psalm

ArgumentTypeCoercion Note

Parameter 1 of closure passed to function array_map expects OCP\Files\Folder, but parent type OCP\Files\Node provided
} catch (\RuntimeException $e) {
$favElements['folders'] = [];
$favElements = [];
}

// If the file doesn't exists in the folder and
Expand Down Expand Up @@ -260,7 +265,7 @@ public function index($dir = '', $view = '', $fileid = null, $fileNotFound = fal
$this->initialState->provideInitialState('storageStats', $storageInfo);
$this->initialState->provideInitialState('config', $this->userConfig->getConfigs());
$this->initialState->provideInitialState('viewConfigs', $this->viewConfig->getConfigs());
$this->initialState->provideInitialState('favoriteFolders', $favElements['folders'] ?? []);
$this->initialState->provideInitialState('favoriteFolders', $favElements);

// File sorting user config
$filesSortingConfig = json_decode($this->config->getUserValue($userId, 'files', 'files_sorting_configs', '{}'), true);
Expand Down
4 changes: 2 additions & 2 deletions apps/files/src/views/Navigation.vue
Original file line number Diff line number Diff line change
Expand Up @@ -228,8 +228,8 @@ export default {
*/
generateToNavigation(view: View) {
if (view.params) {
const { dir, fileid } = view.params
return { name: 'filelist', params: view.params, query: { dir, fileid } }
const { dir } = view.params
return { name: 'filelist', params: view.params, query: { dir } }
}
return { name: 'filelist', params: { view: view.id } }
},
Expand Down
17 changes: 12 additions & 5 deletions apps/files/src/views/favorites.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,22 @@ import { getContents } from '../services/Favorites'
import { hashCode } from '../utils/hashUtils'
import logger from '../logger'

export const generateFolderView = function(folder: string, index = 0): View {
// The return type of the initial state
interface IFavoriteFolder {
fileid: number
path: string
}

export const generateFolderView = function(folder: IFavoriteFolder, index = 0): View {
return new View({
id: generateIdFromPath(folder),
name: basename(folder),
id: generateIdFromPath(folder.path),
name: basename(folder.path),

icon: FolderSvg,
order: index,
params: {
dir: folder,
dir: folder.path,
fileid: folder.fileid.toString(),
view: 'favorites',
},

Expand All @@ -57,7 +64,7 @@ export const generateIdFromPath = function(path: string): string {

export default () => {
// Load state in function for mock testing purposes
const favoriteFolders = loadState<string[]>('files', 'favoriteFolders', [])
const favoriteFolders = loadState<IFavoriteFolder[]>('files', 'favoriteFolders', [])
const favoriteFoldersViews = favoriteFolders.map((folder, index) => generateFolderView(folder, index)) as View[]

const Navigation = getNavigation()
Expand Down

0 comments on commit 98e6568

Please sign in to comment.