/* This file is part of the KDE libraries SPDX-FileCopyrightText: 2000-2005 David Faure SPDX-License-Identifier: LGPL-2.0-only */ #ifndef KIO_GLOBAL_H #define KIO_GLOBAL_H #include "kiocore_export.h" #include // for QFile::Permissions #include #include class QUrl; class QTime; #if defined(Q_OS_WIN) && defined(Q_CC_MSVC) // on windows ssize_t is not defined, only SSIZE_T exists #include typedef SSIZE_T ssize_t; #endif /*! * \namespace KIO * \inmodule KIOCore * \brief A namespace for KIO globals. */ namespace KIO { /// 64-bit file offset typedef qlonglong fileoffset_t; /// 64-bit file size typedef qulonglong filesize_t; /*! * Converts \a size from bytes to the string representation. * * \a size size in bytes * * Returns converted size as a string - e.g. 123.4 KiB , 12.0 MiB */ KIOCORE_EXPORT QString convertSize(KIO::filesize_t size); /*! * Converts a size to a string representation * Not unlike QString::number(...) * * \a size size in bytes * * Returns converted size as a string - e.g. 123456789 */ KIOCORE_EXPORT QString number(KIO::filesize_t size); /*! * Converts size from kibi-bytes (2^10) to the string representation. * * \a kibSize size in kibi-bytes (2^10) * * Returns converted size as a string - e.g. 123.4 KiB , 12.0 MiB */ KIOCORE_EXPORT QString convertSizeFromKiB(KIO::filesize_t kibSize); /*! * Calculates remaining time in seconds from total size, processed size and speed. * * \a totalSize total size in bytes * * \a processedSize processed size in bytes * * \a speed speed in bytes per second * * Returns calculated remaining time in seconds */ KIOCORE_EXPORT unsigned int calculateRemainingSeconds(KIO::filesize_t totalSize, KIO::filesize_t processedSize, KIO::filesize_t speed); /*! * Convert @p seconds to a string representing number of days, hours, minutes and seconds * * \a seconds number of seconds to convert * * Returns string representation in a locale depending format */ KIOCORE_EXPORT QString convertSeconds(unsigned int seconds); /*! * Helper for showing information about a set of files and directories * \a items the number of items (= @p files + @p dirs + number of symlinks :) * * \a files the number of files * * \a dirs the number of dirs * * \a size the sum of the size of the @p files * * \a showSize whether to show the size in the result * * Returns the summary string */ KIOCORE_EXPORT QString itemsSummaryString(uint items, uint files, uint dirs, KIO::filesize_t size, bool showSize); /*! * Encodes (from the text displayed to the real filename) * This translates '/' into a "unicode fraction slash", QChar(0x2044). * Used by KIO::link, for instance. * * \a str the file name to encode * * Returns the encoded file name */ KIOCORE_EXPORT QString encodeFileName(const QString &str); /*! * Decodes (from the filename to the text displayed) * This doesn't do anything anymore, it used to do the opposite of encodeFileName * when encodeFileName was using %2F for '/'. * * \a str the file name to decode * * Returns the decoded file name */ KIOCORE_EXPORT QString decodeFileName(const QString &str); /*! * Error codes that can be emitted by KIO. * * \value [since 6.27] ERR_NONE No error * \value ERR_CANNOT_OPEN_FOR_READING * \value ERR_CANNOT_OPEN_FOR_WRITING * \value ERR_CANNOT_LAUNCH_PROCESS * \value ERR_INTERNAL * \value ERR_MALFORMED_URL * \value ERR_UNSUPPORTED_PROTOCOL * \value ERR_NO_SOURCE_PROTOCOL * \value ERR_UNSUPPORTED_ACTION * \value ERR_IS_DIRECTORY ... where a file was expected * \value ERR_IS_FILE ... where a directory was expected (e.g.\ listing) * \value ERR_DOES_NOT_EXIST * \value ERR_FILE_ALREADY_EXIST * \value ERR_DIR_ALREADY_EXIST * \value ERR_UNKNOWN_HOST * \value ERR_ACCESS_DENIED * \value ERR_WRITE_ACCESS_DENIED * \value ERR_CANNOT_ENTER_DIRECTORY * \value ERR_PROTOCOL_IS_NOT_A_FILESYSTEM * \value ERR_CYCLIC_LINK * \value ERR_USER_CANCELED * \value ERR_CYCLIC_COPY * \value ERR_CANNOT_CREATE_SOCKET * \value ERR_CANNOT_CONNECT * \value ERR_CONNECTION_BROKEN * \value ERR_NOT_FILTER_PROTOCOL * \value ERR_CANNOT_MOUNT * \value ERR_CANNOT_UNMOUNT * \value ERR_CANNOT_READ * \value ERR_CANNOT_WRITE * \value ERR_CANNOT_BIND * \value ERR_CANNOT_LISTEN * \value ERR_CANNOT_ACCEPT * \value ERR_CANNOT_LOGIN * \value ERR_CANNOT_STAT * \value ERR_CANNOT_CLOSEDIR * \value ERR_CANNOT_MKDIR * \value ERR_CANNOT_RMDIR * \value ERR_CANNOT_RESUME * \value ERR_CANNOT_RENAME * \value ERR_CANNOT_CHMOD * \value ERR_CANNOT_DELETE * \value [since 5.96] ERR_WORKER_DIED The text argument is the protocol that the dead worker supported. This means for example: file, ftp, http, ... * \value ERR_OUT_OF_MEMORY * \value ERR_UNKNOWN_PROXY_HOST * \value ERR_CANNOT_AUTHENTICATE * \value ERR_ABORTED Action got aborted from application side * \value ERR_INTERNAL_SERVER * \value ERR_SERVER_TIMEOUT * \value ERR_SERVICE_NOT_AVAILABLE * \value ERR_UNKNOWN * \value ERR_UNKNOWN_INTERRUPT * \value ERR_CANNOT_DELETE_ORIGINAL * \value ERR_CANNOT_DELETE_PARTIAL * \value ERR_CANNOT_RENAME_ORIGINAL * \value ERR_CANNOT_RENAME_PARTIAL * \value ERR_NEED_PASSWD * \value ERR_CANNOT_SYMLINK * \value ERR_NO_CONTENT Action succeeded but no content will follow * \value ERR_DISK_FULL * \value ERR_IDENTICAL_FILES src==dest when moving/copying * \value [since 5.96] ERR_WORKER_DEFINED For worker specified errors that can be rich text. Email links will be handled by the standard email app and all hrefs * will be handled by the standard browser. will be forked. * \value ERR_UPGRADE_REQUIRED A transport upgrade is required to access this object. For instance, TLS is demanded by the server in order to continue * \value ERR_POST_DENIED Issued when trying to POST data to a certain Ports * \value ERR_CANNOT_SEEK * \value ERR_CANNOT_SETTIME Emitted by setModificationTime * \value ERR_CANNOT_CHOWN * \value ERR_POST_NO_SIZE * \value [since 5.6] ERR_DROP_ON_ITSELF from KIO::DropJob * \value [since 5.18] ERR_CANNOT_MOVE_INTO_ITSELF emitted by KIO::move * \value [since 5.24] ERR_PASSWD_SERVER returned by WorkerBase::openPasswordDialog * \value [since 5.96] ERR_CANNOT_CREATE_WORKER used by Worker::createWorker * \value [since 5.54] ERR_FILE_TOO_LARGE_FOR_FAT32 * \value [since 5.54] ERR_OWNER_DIED Value used between kuiserver and views when the job owner disappears unexpectedly. It should not be emitted by workers * \value [since 5.60] ERR_PRIVILEGE_NOT_REQUIRED used by file ioworker * \value [since 5.66] ERR_CANNOT_TRUNCATE used by FileJob::truncate * \value [since 5.88] ERR_SYMLINKS_NOT_SUPPORTED Indicates failure to create a symlink due to the underlying filesystem (FAT/ExFAT) not supporting them. Used * by e.g. CopyJob * \value [since 5.100] ERR_TRASH_FILE_TOO_LARGE Moving files/dirs to the Trash failed due to size constraints * \value [since 6.21] ERR_TRASH_NOT_AVAILABLE Moving files/dirs to the Trash failed because a trash directory is not available for their location. */ // TODO KF7: rename to Result, and ERR_NONE to OK enum Error { ERR_NONE = KJob::NoError, ERR_CANNOT_OPEN_FOR_READING = KJob::UserDefinedError + 1, ERR_CANNOT_OPEN_FOR_WRITING = KJob::UserDefinedError + 2, ERR_CANNOT_LAUNCH_PROCESS = KJob::UserDefinedError + 3, ERR_INTERNAL = KJob::UserDefinedError + 4, ERR_MALFORMED_URL = KJob::UserDefinedError + 5, ERR_UNSUPPORTED_PROTOCOL = KJob::UserDefinedError + 6, ERR_NO_SOURCE_PROTOCOL = KJob::UserDefinedError + 7, ERR_UNSUPPORTED_ACTION = KJob::UserDefinedError + 8, ERR_IS_DIRECTORY = KJob::UserDefinedError + 9, ERR_IS_FILE = KJob::UserDefinedError + 10, ERR_DOES_NOT_EXIST = KJob::UserDefinedError + 11, ERR_FILE_ALREADY_EXIST = KJob::UserDefinedError + 12, ERR_DIR_ALREADY_EXIST = KJob::UserDefinedError + 13, ERR_UNKNOWN_HOST = KJob::UserDefinedError + 14, ERR_ACCESS_DENIED = KJob::UserDefinedError + 15, ERR_WRITE_ACCESS_DENIED = KJob::UserDefinedError + 16, ERR_CANNOT_ENTER_DIRECTORY = KJob::UserDefinedError + 17, ERR_PROTOCOL_IS_NOT_A_FILESYSTEM = KJob::UserDefinedError + 18, ERR_CYCLIC_LINK = KJob::UserDefinedError + 19, ERR_USER_CANCELED = KJob::KilledJobError, ERR_CYCLIC_COPY = KJob::UserDefinedError + 21, ERR_CANNOT_CREATE_SOCKET = KJob::UserDefinedError + 22, ERR_CANNOT_CONNECT = KJob::UserDefinedError + 23, ERR_CONNECTION_BROKEN = KJob::UserDefinedError + 24, ERR_NOT_FILTER_PROTOCOL = KJob::UserDefinedError + 25, ERR_CANNOT_MOUNT = KJob::UserDefinedError + 26, ERR_CANNOT_UNMOUNT = KJob::UserDefinedError + 27, ERR_CANNOT_READ = KJob::UserDefinedError + 28, ERR_CANNOT_WRITE = KJob::UserDefinedError + 29, ERR_CANNOT_BIND = KJob::UserDefinedError + 30, ERR_CANNOT_LISTEN = KJob::UserDefinedError + 31, ERR_CANNOT_ACCEPT = KJob::UserDefinedError + 32, ERR_CANNOT_LOGIN = KJob::UserDefinedError + 33, ERR_CANNOT_STAT = KJob::UserDefinedError + 34, ERR_CANNOT_CLOSEDIR = KJob::UserDefinedError + 35, ERR_CANNOT_MKDIR = KJob::UserDefinedError + 37, ERR_CANNOT_RMDIR = KJob::UserDefinedError + 38, ERR_CANNOT_RESUME = KJob::UserDefinedError + 39, ERR_CANNOT_RENAME = KJob::UserDefinedError + 40, ERR_CANNOT_CHMOD = KJob::UserDefinedError + 41, ERR_CANNOT_DELETE = KJob::UserDefinedError + 42, ERR_WORKER_DIED = KJob::UserDefinedError + 43, ERR_OUT_OF_MEMORY = KJob::UserDefinedError + 44, ERR_UNKNOWN_PROXY_HOST = KJob::UserDefinedError + 45, ERR_CANNOT_AUTHENTICATE = KJob::UserDefinedError + 46, ERR_ABORTED = KJob::UserDefinedError + 47, ERR_INTERNAL_SERVER = KJob::UserDefinedError + 48, ERR_SERVER_TIMEOUT = KJob::UserDefinedError + 49, ERR_SERVICE_NOT_AVAILABLE = KJob::UserDefinedError + 50, ERR_UNKNOWN = KJob::UserDefinedError + 51, // (was a warning) ERR_CHECKSUM_MISMATCH = 52, ERR_UNKNOWN_INTERRUPT = KJob::UserDefinedError + 53, ERR_CANNOT_DELETE_ORIGINAL = KJob::UserDefinedError + 54, ERR_CANNOT_DELETE_PARTIAL = KJob::UserDefinedError + 55, ERR_CANNOT_RENAME_ORIGINAL = KJob::UserDefinedError + 56, ERR_CANNOT_RENAME_PARTIAL = KJob::UserDefinedError + 57, ERR_NEED_PASSWD = KJob::UserDefinedError + 58, ERR_CANNOT_SYMLINK = KJob::UserDefinedError + 59, ERR_NO_CONTENT = KJob::UserDefinedError + 60, ERR_DISK_FULL = KJob::UserDefinedError + 61, ERR_IDENTICAL_FILES = KJob::UserDefinedError + 62, ERR_WORKER_DEFINED = KJob::UserDefinedError + 63, ERR_UPGRADE_REQUIRED = KJob::UserDefinedError + 64, ERR_POST_DENIED = KJob::UserDefinedError + 65, ERR_CANNOT_SEEK = KJob::UserDefinedError + 66, ERR_CANNOT_SETTIME = KJob::UserDefinedError + 67, ERR_CANNOT_CHOWN = KJob::UserDefinedError + 68, ERR_POST_NO_SIZE = KJob::UserDefinedError + 69, ERR_DROP_ON_ITSELF = KJob::UserDefinedError + 70, ERR_CANNOT_MOVE_INTO_ITSELF = KJob::UserDefinedError + 71, ERR_PASSWD_SERVER = KJob::UserDefinedError + 72, ERR_CANNOT_CREATE_WORKER = KJob::UserDefinedError + 73, ERR_FILE_TOO_LARGE_FOR_FAT32 = KJob::UserDefinedError + 74, ERR_OWNER_DIED = KJob::UserDefinedError + 75, ERR_PRIVILEGE_NOT_REQUIRED = KJob::UserDefinedError + 76, ERR_CANNOT_TRUNCATE = KJob::UserDefinedError + 77, ERR_SYMLINKS_NOT_SUPPORTED = KJob::UserDefinedError + 78, ERR_TRASH_FILE_TOO_LARGE = KJob::UserDefinedError + 79, ERR_TRASH_NOT_AVAILABLE = KJob::UserDefinedError + 80, }; #if KIOCORE_ENABLE_DEPRECATED_SINCE(6, 6) /*! * Specifies how to use the cache. * \sa parseCacheControl() * \sa getCacheControlString() * \deprecated[6.6] * Not used * \value CC_CacheOnly Fail request if not in cache * \value CC_Cache Use cached entry if available * \value CC_Verify Validate cached entry with remote site if expired * \value CC_Refresh Always validate cached entry with remote site * \value CC_Reload Always fetch from remote site */ enum KIOCORE_DEPRECATED_VERSION(6, 6, "Not used") CacheControl { CC_CacheOnly, CC_Cache, CC_Verify, CC_Refresh, CC_Reload, }; #endif #if KIOCORE_ENABLE_DEPRECATED_SINCE(6, 19) /*! * Specifies privilege file operation status. * \since 5.43 * * \value OperationAllowed * \value OperationCanceled * \value OperationNotAllowed * * \deprecated[6.19] */ enum PrivilegeOperationStatus { OperationAllowed = 1, OperationCanceled, OperationNotAllowed, }; #endif /*! * Describes the fields that a stat command will retrieve * \sa UDSEntry * \since 5.69 * * \value StatNoDetails No field returned, useful to check if a file exists * \value StatBasic Filename, access, type, size, linkdest * \value StatUser uid, gid * \value StatTime * \value StatResolveSymlink Resolve symlinks * \value StatAcl ACL data * \value StatInode dev, inode * \value [since 5.70] StatRecursiveSize Recursive size * \value [since 5.82] StatMimeType MIME type * \value StatDefaultDetails Default StatDetail flag when creating a StatJob. Equivalent to setting \c{StatBasic | StatUser | StatTime | StatAcl | * StatResolveSymlink} * \value [since 6.23] StatSubVolId in case the filesystem supports it, return its subvol Identifier * \value [since 6.23] StatMountId the unique mount identifier, see man statx * \value [since 6.24] StatTimeNsOffset Stat will provide nanosecond precision offsets when available * \value [since 6.30] StatSizeOnDisk the space the file takes up on its storage, see UDS_SIZE_ON_DISK. Off by default, since a listing carries one number * per entry and most callers only want the size of the data */ enum StatDetail { StatNoDetails = 0x0, StatBasic = 0x1, StatUser = 0x2, StatTime = 0x4, StatResolveSymlink = 0x8, StatAcl = 0x10, StatDefaultDetails = StatBasic | StatUser | StatTime | StatAcl | StatResolveSymlink, StatInode = 0x20, StatRecursiveSize = 0x40, StatMimeType = 0x80, StatSubVolId = 0x100, StatMountId = 0x200, StatTimeNsOffset = 0x400 | StatTime, StatSizeOnDisk = 0x800, }; Q_DECLARE_FLAGS(StatDetails, StatDetail) Q_DECLARE_OPERATORS_FOR_FLAGS(KIO::StatDetails) #if KIOCORE_ENABLE_DEPRECATED_SINCE(6, 6) /*! * Parses the string representation of the cache control option. * * \a cacheControl the string representation * * Returns the cache control value. * * Not used * * \sa getCacheControlString() * \deprecated[6.6] */ KIOCORE_EXPORT KIO::CacheControl parseCacheControl(const QString &cacheControl); #endif #if KIOCORE_ENABLE_DEPRECATED_SINCE(6, 6) /*! * Returns a string representation of the given cache control method. * * \a cacheControl the cache control method * * Returns the string representation * * Not used. * * \sa parseCacheControl() * \deprecated[6.6] */ KIOCORE_DEPRECATED_VERSION(6, 6, "Not used") KIOCORE_EXPORT QString getCacheControlString(KIO::CacheControl cacheControl); #endif /*! * Return the "favicon" (see http://www.favicon.com) for the given \a url, * if available. Does NOT attempt to download the favicon, it only returns * one that is already available. * * If unavailable, returns QString(). * Use KIO::FavIconRequestJob instead of this method if you can wait * for the favicon to be downloaded. * * \a url the URL of the favicon * * Returns the path to the icon (to be passed to QIcon()), or QString() * * \since 5.0 */ KIOCORE_EXPORT QString favIconForUrl(const QUrl &url); /*! * Converts KIO file permissions from mode_t to QFile::Permissions format. * * This is a convenience function for converting KIO permissions parameter from * mode_t to QFile::Permissions. * * \a permissions KIO file permissions. * * Returns -1 if \a permissions is -1, otherwise its OR'ed QFile::Permission equivalent. */ KIOCORE_EXPORT QFile::Permissions convertPermissions(int permissions); /*! * Return the icon name for a URL. * Most of the time this returns the MIME type icon, * but also has fallback to favicon and protocol-specific icon. * * Pass this to QIcon::fromTheme(). * * \since 5.0 */ KIOCORE_EXPORT QString iconNameForUrl(const QUrl &url); /*! * This function is useful to implement the "Up" button in a file manager for example. * * Returns a URL that is a level higher * * \since 5.0 */ KIOCORE_EXPORT QUrl upUrl(const QUrl &url); } #endif