@nextcloud/files 3.5.1 → 3.6.0

package/README.md

@@ -5,7 +5,9 @@
 # @nextcloud/files
 [![npm last version](https://img.shields.io/npm/v/@nextcloud/files.svg?style=flat-square)](https://www.npmjs.com/package/@nextcloud/files) [![REUSE status](https://api.reuse.software/badge/github.com/nextcloud-libraries/nextcloud-files)](https://api.reuse.software/info/github.com/nextcloud-libraries/nextcloud-files) [![Code coverage](https://img.shields.io/codecov/c/github/nextcloud-libraries/nextcloud-files?style=flat-square)](https://app.codecov.io/gh/nextcloud-libraries/nextcloud-files) [![Project documentation](https://img.shields.io/badge/documentation-online-blue?style=flat-square)](https://nextcloud-libraries.github.io/nextcloud-files/)
 
-Nextcloud Files helpers for Nextcloud apps and libraries
+Nextcloud Files helpers for Nextcloud apps and libraries.
+
+The `davGetClient` exported function returns a webDAV client that's a wrapper around [webdav's webDAV client](https://www.npmjs.com/package/webdav); All its methods are available here.
 
 ## Usage example
 
@@ -57,3 +59,18 @@ const nodes = results.data.map((result) => davResultToNode(r, myRoot))
 const nodes = results.data.map((result) => davResultToNode(r, myRoot, myRemoteURL))
 
 ```
+
+### Using WebDAV to get a Node from a file's name
+
+```ts
+	import { davGetClient, davGetDefaultPropfind, davResultToNode, davRootPath } from '@nextcloud/files'
+	import { emit } from '@nextcloud/event-bus'
+	const client = davGetClient()
+	client.stat(`${davRootPath}${filename}`, {
+		details: true,
+		data: davGetDefaultPropfind(),
+	}).then((result) => {
+		const node = davResultToNode(result.data)
+		emit('files:node:updated', node)
+	})
+```

package/dist/files/node.d.ts

@@ -35,6 +35,17 @@ export declare abstract class Node {
      * You can use the rename or move method to change the source.
      */
     get basename(): string;
+    /**
+     * The nodes displayname
+     * By default the display name and the `basename` are identical,
+     * but it is possible to have a different name. This happens
+     * on the files app for example for shared folders.
+     */
+    get displayname(): string;
+    /**
+     * Set the displayname
+     */
+    set displayname(displayname: string);
     /**
      * Get this object's extension
      * There is no setter as the source is not meant to be changed manually.

package/dist/files/nodeData.d.ts

@@ -25,6 +25,8 @@ export interface NodeData {
     permissions?: Permission;
     /** The owner  UID of this node */
     owner: string | null;
+    /** Optional the displayname of this node */
+    displayname?: string;
     /** The node attributes */
     attributes?: Attribute;
     /**

package/dist/index.cjs

@@ -8,6 +8,7 @@ const router = require("@nextcloud/router");
 const cancelablePromise = require("cancelable-promise");
 const webdav = require("webdav");
 const _public = require("@nextcloud/sharing/public");
+const capabilities = require("@nextcloud/capabilities");
 const l10n = require("@nextcloud/l10n");
 const typescriptEventTarget = require("typescript-event-target");
 const logger = logger$1.getLoggerBuilder().setApp("@nextcloud/files").detectUser().build();
@@ -430,6 +431,9 @@ const validateData = (data, davService) => {
   if (!data.source.startsWith("http")) {
     throw new Error("Invalid source format, only http(s) is supported");
   }
+  if (data.displayname && typeof data.displayname !== "string") {
+    throw new Error("Invalid displayname type");
+  }
   if (data.mtime && !(data.mtime instanceof Date)) {
     throw new Error("Invalid mtime type");
   }
@@ -506,7 +510,12 @@ class Node {
   };
   constructor(data, davService) {
     validateData(data, davService || this._knownDavService);
-    this._data = { ...data, attributes: {} };
+    this._data = {
+      // TODO: Remove with next major release, this is just for compatibility
+      displayname: data.attributes?.displayname,
+      ...data,
+      attributes: {}
+    };
     this._attributes = new Proxy(this._data.attributes, this.handler);
     this.update(data.attributes ?? {});
     if (davService) {
@@ -536,6 +545,21 @@ class Node {
   get basename() {
     return path.basename(this.source);
   }
+  /**
+   * The nodes displayname
+   * By default the display name and the `basename` are identical,
+   * but it is possible to have a different name. This happens
+   * on the files app for example for shared folders.
+   */
+  get displayname() {
+    return this._data.displayname || this.basename;
+  }
+  /**
+   * Set the displayname
+   */
+  set displayname(displayname) {
+    this._data.displayname = displayname;
+  }
   /**
    * Get this object's extension
    * There is no setter as the source is not meant to be changed manually.
@@ -698,7 +722,11 @@ class Node {
    */
   move(destination) {
     validateData({ ...this._data, source: destination }, this._knownDavService);
+    const oldBasename = this.basename;
     this._data.source = destination;
+    if (this.displayname === oldBasename && this.basename !== oldBasename) {
+      this.displayname = this.basename;
+    }
     this.updateMtime();
   }
   /**
@@ -843,6 +871,7 @@ const davResultToNode = function(node, filesRoot = davRootPath, remoteURL = davR
     source: `${remoteURL}${node.filename}`,
     mtime: new Date(Date.parse(node.lastmod)),
     mime: node.mime || "application/octet-stream",
+    displayname: props.displayname,
     size: props?.size || Number.parseInt(props.getcontentlength || "0"),
     // The fileid is set to -1 for failed requests
     status: id < 0 ? NodeStatus.FAILED : void 0,
@@ -858,16 +887,81 @@ const davResultToNode = function(node, filesRoot = davRootPath, remoteURL = davR
   delete nodeData.attributes?.props;
   return node.type === "file" ? new File(nodeData) : new Folder(nodeData);
 };
-const forbiddenCharacters = window._oc_config?.forbidden_filenames_characters ?? ["/", "\\"];
-const forbiddenFilenameRegex = window._oc_config?.blacklist_files_regex ? new RegExp(window._oc_config.blacklist_files_regex) : null;
-function isFilenameValid(filename) {
-  if (forbiddenCharacters.some((character) => filename.includes(character))) {
-    return false;
+var InvalidFilenameErrorReason = /* @__PURE__ */ ((InvalidFilenameErrorReason2) => {
+  InvalidFilenameErrorReason2["ReservedName"] = "reserved name";
+  InvalidFilenameErrorReason2["Character"] = "character";
+  InvalidFilenameErrorReason2["Extension"] = "extension";
+  return InvalidFilenameErrorReason2;
+})(InvalidFilenameErrorReason || {});
+class InvalidFilenameError extends Error {
+  constructor(options) {
+    super(`Invalid ${options.reason} '${options.segment}' in filename '${options.filename}'`, { cause: options });
   }
-  if (forbiddenFilenameRegex !== null && filename.match(forbiddenFilenameRegex)) {
-    return false;
+  /**
+   * The filename that was validated
+   */
+  get filename() {
+    return this.cause.filename;
+  }
+  /**
+   * Reason why the validation failed
+   */
+  get reason() {
+    return this.cause.reason;
+  }
+  /**
+   * Part of the filename that caused this error
+   */
+  get segment() {
+    return this.cause.segment;
+  }
+}
+function validateFilename(filename) {
+  const capabilities$1 = capabilities.getCapabilities().files;
+  const forbiddenCharacters = capabilities$1.forbidden_filename_characters ?? window._oc_config?.forbidden_filenames_characters ?? ["/", "\\"];
+  for (const character of forbiddenCharacters) {
+    if (filename.includes(character)) {
+      throw new InvalidFilenameError({ segment: character, reason: "character", filename });
+    }
+  }
+  filename = filename.toLocaleLowerCase();
+  const forbiddenFilenames = capabilities$1.forbidden_filenames ?? [".htaccess"];
+  if (forbiddenFilenames.includes(filename)) {
+    throw new InvalidFilenameError({
+      filename,
+      segment: filename,
+      reason: "reserved name"
+      /* ReservedName */
+    });
+  }
+  const endOfBasename = filename.indexOf(".", 1);
+  const basename = filename.substring(0, endOfBasename === -1 ? void 0 : endOfBasename);
+  const forbiddenFilenameBasenames = capabilities$1.forbidden_filename_basenames ?? [];
+  if (forbiddenFilenameBasenames.includes(basename)) {
+    throw new InvalidFilenameError({
+      filename,
+      segment: basename,
+      reason: "reserved name"
+      /* ReservedName */
+    });
+  }
+  const forbiddenFilenameExtensions = capabilities$1.forbidden_filename_extensions ?? [".part", ".filepart"];
+  for (const extension of forbiddenFilenameExtensions) {
+    if (filename.length > extension.length && filename.endsWith(extension)) {
+      throw new InvalidFilenameError({ segment: extension, reason: "extension", filename });
+    }
+  }
+}
+function isFilenameValid(filename) {
+  try {
+    validateFilename(filename);
+    return true;
+  } catch (error) {
+    if (error instanceof InvalidFilenameError) {
+      return false;
+    }
+    throw error;
   }
-  return true;
 }
 function getUniqueName(name, otherNames, options) {
   const opts = {
@@ -2813,6 +2907,8 @@ exports.FileType = FileType;
 exports.FilesSortingMode = FilesSortingMode;
 exports.Folder = Folder;
 exports.Header = Header;
+exports.InvalidFilenameError = InvalidFilenameError;
+exports.InvalidFilenameErrorReason = InvalidFilenameErrorReason;
 exports.Navigation = Navigation;
 exports.NewMenuEntryCategory = NewMenuEntryCategory;
 exports.Node = Node;
@@ -2849,3 +2945,4 @@ exports.registerFileAction = registerFileAction;
 exports.registerFileListHeaders = registerFileListHeaders;
 exports.removeNewFileMenuEntry = removeNewFileMenuEntry;
 exports.sortNodes = sortNodes;
+exports.validateFilename = validateFilename;