global.h
00001 /* This file is part of the KDE libraries 00002 Copyright (C) 2000 David Faure <faure@kde.org> 00003 00004 This library is free software; you can redistribute it and/or 00005 modify it under the terms of the GNU Library General Public 00006 License version 2 as published by the Free Software Foundation. 00007 00008 This library is distributed in the hope that it will be useful, 00009 but WITHOUT ANY WARRANTY; without even the implied warranty of 00010 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 00011 Library General Public License for more details. 00012 00013 You should have received a copy of the GNU Library General Public License 00014 along with this library; see the file COPYING.LIB. If not, write to 00015 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, 00016 Boston, MA 02110-1301, USA. 00017 */ 00018 #ifndef __kio_global_h__ 00019 #define __kio_global_h__ 00020 00021 #include <tqstring.h> 00022 #include <tqvaluelist.h> 00023 #include <tqptrlist.h> 00024 #include <tqdatastream.h> 00025 #include <tqdatetime.h> 00026 #include <tqmap.h> 00027 00028 #include <kurl.h> 00029 00034 namespace KIO 00035 { 00037 typedef TQ_LLONG fileoffset_t; 00039 typedef TQ_ULLONG filesize_t; 00040 00047 KIO_EXPORT TQString convertSize( KIO::filesize_t size ); 00048 00056 KIO_EXPORT TQString convertSizeWithBytes( KIO::filesize_t size ); 00064 KIO_EXPORT TQString number( KIO::filesize_t size ); 00065 00072 KIO_EXPORT TQString convertSizeFromKB( KIO::filesize_t kbSize ); 00073 00084 KIO_EXPORT unsigned int calculateRemainingSeconds( KIO::filesize_t totalSize, 00085 KIO::filesize_t processedSize, KIO::filesize_t speed ); 00086 00095 KIO_EXPORT TQString convertSeconds( unsigned int seconds ); 00096 00106 KIO_EXPORT TQTime calculateRemaining( KIO::filesize_t totalSize, KIO::filesize_t processedSize, KIO::filesize_t speed ) KDE_DEPRECATED; 00107 00117 KIO_EXPORT TQString itemsSummaryString(uint items, uint files, uint dirs, KIO::filesize_t size, bool showSize); 00118 00126 KIO_EXPORT TQString encodeFileName( const TQString & str ); 00133 KIO_EXPORT TQString decodeFileName( const TQString & str ); 00134 00138 enum Command { 00139 CMD_HOST = '0', // 48 00140 CMD_CONNECT = '1', // 49 00141 CMD_DISCONNECT = '2', // 50 00142 CMD_SLAVE_STATUS = '3', // 51 00143 CMD_SLAVE_CONNECT = '4', // 52 00144 CMD_SLAVE_HOLD = '5', // 53 00145 CMD_NONE = 'A', // 65 00146 CMD_TESTDIR = 'B', // 66 00147 CMD_GET = 'C', // 67 00148 CMD_PUT = 'D', // 68 00149 CMD_STAT = 'E', // 69 00150 CMD_MIMETYPE = 'F', // 70 00151 CMD_LISTDIR = 'G', // 71 00152 CMD_MKDIR = 'H', // 72 00153 CMD_RENAME = 'I', // 73 00154 CMD_COPY = 'J', // 74 00155 CMD_DEL = 'K', // 75 00156 CMD_CHMOD = 'L', // 76 00157 CMD_SPECIAL = 'M', // 77 00158 CMD_USERPASS = 'N', // 78 00159 CMD_REPARSECONFIGURATION = 'O', // 79 00160 CMD_META_DATA = 'P', // 80 00161 CMD_SYMLINK = 'Q', // 81 00162 CMD_SUBURL = 'R', // 82 Inform the slave about the url it is streaming on. 00163 CMD_MESSAGEBOXANSWER = 'S', // 83 00164 CMD_RESUMEANSWER = 'T', // 84 00165 CMD_CONFIG = 'U', // 85 00166 CMD_MULTI_GET = 'V' // 86 00167 // Add new ones here once a release is done, to avoid breaking binary compatibility. 00168 // Note that protocol-specific commands shouldn't be added here, but should use special. 00169 }; 00170 00174 enum Error { 00175 ERR_CANNOT_OPEN_FOR_READING = 1, 00176 ERR_CANNOT_OPEN_FOR_WRITING = 2, 00177 ERR_CANNOT_LAUNCH_PROCESS = 3, 00178 ERR_INTERNAL = 4, 00179 ERR_MALFORMED_URL = 5, 00180 ERR_UNSUPPORTED_PROTOCOL = 6, 00181 ERR_NO_SOURCE_PROTOCOL = 7, 00182 ERR_UNSUPPORTED_ACTION = 8, 00183 ERR_IS_DIRECTORY = 9, // ... where a file was expected 00184 ERR_IS_FILE = 10, // ... where a directory was expected (e.g. listing) 00185 ERR_DOES_NOT_EXIST = 11, 00186 ERR_FILE_ALREADY_EXIST = 12, 00187 ERR_DIR_ALREADY_EXIST = 13, 00188 ERR_UNKNOWN_HOST = 14, 00189 ERR_ACCESS_DENIED = 15, 00190 ERR_WRITE_ACCESS_DENIED = 16, 00191 ERR_CANNOT_ENTER_DIRECTORY = 17, 00192 ERR_PROTOCOL_IS_NOT_A_FILESYSTEM = 18, 00193 ERR_CYCLIC_LINK = 19, 00194 ERR_USER_CANCELED = 20, 00195 ERR_CYCLIC_COPY = 21, 00196 ERR_COULD_NOT_CREATE_SOCKET = 22, // KDE4: s/COULD_NOT/CANNOT/ or the other way round 00197 ERR_COULD_NOT_CONNECT = 23, 00198 ERR_CONNECTION_BROKEN = 24, 00199 ERR_NOT_FILTER_PROTOCOL = 25, 00200 ERR_COULD_NOT_MOUNT = 26, 00201 ERR_COULD_NOT_UNMOUNT = 27, 00202 ERR_COULD_NOT_READ = 28, 00203 ERR_COULD_NOT_WRITE = 29, 00204 ERR_COULD_NOT_BIND = 30, 00205 ERR_COULD_NOT_LISTEN = 31, 00206 ERR_COULD_NOT_ACCEPT = 32, 00207 ERR_COULD_NOT_LOGIN = 33, 00208 ERR_COULD_NOT_STAT = 34, 00209 ERR_COULD_NOT_CLOSEDIR = 35, 00210 ERR_COULD_NOT_MKDIR = 37, 00211 ERR_COULD_NOT_RMDIR = 38, 00212 ERR_CANNOT_RESUME = 39, 00213 ERR_CANNOT_RENAME = 40, 00214 ERR_CANNOT_CHMOD = 41, 00215 ERR_CANNOT_DELETE = 42, 00216 // The text argument is the protocol that the dead slave supported. 00217 // This means for example: file, ftp, http, ... 00218 ERR_SLAVE_DIED = 43, 00219 ERR_OUT_OF_MEMORY = 44, 00220 ERR_UNKNOWN_PROXY_HOST = 45, 00221 ERR_COULD_NOT_AUTHENTICATE = 46, 00222 ERR_ABORTED = 47, // Action got aborted from application side 00223 ERR_INTERNAL_SERVER = 48, 00224 ERR_SERVER_TIMEOUT = 49, 00225 ERR_SERVICE_NOT_AVAILABLE = 50, 00226 ERR_UNKNOWN = 51, 00227 // (was a warning) ERR_CHECKSUM_MISMATCH = 52, 00228 ERR_UNKNOWN_INTERRUPT = 53, 00229 ERR_CANNOT_DELETE_ORIGINAL = 54, 00230 ERR_CANNOT_DELETE_PARTIAL = 55, 00231 ERR_CANNOT_RENAME_ORIGINAL = 56, 00232 ERR_CANNOT_RENAME_PARTIAL = 57, 00233 ERR_NEED_PASSWD = 58, 00234 ERR_CANNOT_SYMLINK = 59, 00235 ERR_NO_CONTENT = 60, // Action succeeded but no content will follow. 00236 ERR_DISK_FULL = 61, 00237 ERR_IDENTICAL_FILES = 62, // src==dest when moving/copying 00238 ERR_SLAVE_DEFINED = 63, // for slave specified errors that can be 00239 // rich text. Email links will be handled 00240 // by the standard email app and all hrefs 00241 // will be handled by the standard browser. 00242 // <a href="exec:/khelpcenter ?" will be 00243 // forked. 00244 ERR_UPGRADE_REQUIRED = 64, // A transport upgrade is required to access this 00245 // object. For instance, TLS is demanded by 00246 // the server in order to continue. 00247 ERR_POST_DENIED = 65, // Issued when trying to POST data to a certain Ports 00248 // see job.cpp 00249 ERR_OFFLINE_MODE = 66 // Used when an app is in offline mode and a 00250 // requested document is unavailable. 00251 }; 00252 00260 KIO_EXPORT TQString buildErrorString(int errorCode, const TQString &errorText); 00261 00272 KIO_EXPORT TQString buildHTMLErrorString(int errorCode, const TQString &errorText, 00273 const KURL *reqUrl = 0L, int method = -1 ); 00274 00291 KIO_EXPORT TQByteArray rawErrorDetail(int errorCode, const TQString &errorText, 00292 const KURL *reqUrl = 0L, int method = -1 ); 00293 00302 KIO_EXPORT TQString unsupportedActionErrorString(const TQString &protocol, int cmd); 00303 00307 enum UDSAtomTypes { 00309 UDS_STRING = 1, 00310 UDS_LONG = 2, 00311 UDS_TIME = 4 | UDS_LONG, 00312 00313 // To add new UDS entries below, you can use a step of 8 00314 // (i.e. 8, 16, 24, 32, etc.) Only the last 3 bits are a bitfield, 00315 // the rest isn't. 00316 00318 UDS_SIZE = 8 | UDS_LONG, 00319 UDS_SIZE_LARGE = 32768 | UDS_LONG, // For internal use only 00321 UDS_USER = 16 | UDS_STRING, 00325 UDS_ICON_NAME = 24 | UDS_STRING, 00327 UDS_GROUP = 32 | UDS_STRING, 00331 UDS_EXTRA = 48 | UDS_STRING, 00334 UDS_NAME = 64 | UDS_STRING, 00337 UDS_LOCAL_PATH = 72 | UDS_STRING, 00340 UDS_HIDDEN = 80 | UDS_LONG, 00343 UDS_EXTENDED_ACL = 88 | UDS_LONG, 00346 UDS_ACL_STRING = 96 | UDS_STRING, 00350 UDS_DEFAULT_ACL_STRING = 104 | UDS_STRING, 00351 00352 // available: 112, 120 00353 00355 UDS_ACCESS = 128 | UDS_LONG, 00357 UDS_MODIFICATION_TIME = 256 | UDS_TIME, 00359 UDS_ACCESS_TIME = 512 | UDS_TIME, 00361 UDS_CREATION_TIME = 1024 | UDS_TIME, 00365 UDS_FILE_TYPE = 2048 | UDS_LONG, 00368 UDS_LINK_DEST = 4096 | UDS_STRING, 00370 UDS_URL = 8192 | UDS_STRING, 00372 UDS_MIME_TYPE = 16384 | UDS_STRING, 00375 UDS_GUESSED_MIME_TYPE = 16392 | UDS_STRING, 00378 UDS_XML_PROPERTIES = 0x8000 | UDS_STRING 00379 }; 00380 00386 enum CacheControl 00387 { 00388 CC_CacheOnly, 00389 CC_Cache, 00390 CC_Verify, 00391 CC_Refresh, 00392 00393 CC_Reload 00394 }; 00395 00403 KIO_EXPORT KIO::CacheControl parseCacheControl(const TQString &cacheControl); 00404 00412 KIO_EXPORT TQString getCacheControlString(KIO::CacheControl cacheControl); 00413 00419 KIO_EXPORT TQString findDeviceMountPoint( const TQString& device ); 00420 00428 KIO_EXPORT TQString findPathMountPoint( const TQString & filename ); 00429 00437 KIO_EXPORT bool probably_slow_mounted(const TQString& filename); 00438 00445 KIO_EXPORT bool manually_mounted(const TQString& filename); 00446 00447 enum FileSystemFlag { SupportsChmod, SupportsChown, SupportsUTime, 00448 SupportsSymlinks, CaseInsensitive }; 00469 KIO_EXPORT bool testFileSystemFlag(const TQString& filename, FileSystemFlag flag); 00470 00471 00472 /************ 00473 * 00474 * Universal Directory Service 00475 * 00476 * Any file or URL can be represented by the UDSEntry type below 00477 * A UDSEntry is a list of atoms 00478 * Each atom contains a specific bit of information for the file 00479 * 00480 * The following UDS constants represent the different possible values 00481 * for m_uds in the UDS atom structure below 00482 * 00483 * Each atom contains a specific bit of information for the file 00484 */ 00485 class KIO_EXPORT UDSAtom 00486 { 00487 public: 00491 TQString m_str; 00495 long long m_long; 00496 00500 unsigned int m_uds; 00501 }; 00502 00506 typedef TQValueList<UDSAtom> UDSEntry; 00507 typedef TQValueList<UDSEntry> UDSEntryList; 00508 typedef TQValueListIterator<UDSEntry> UDSEntryListIterator; 00509 typedef TQValueListConstIterator<UDSEntry> UDSEntryListConstIterator; 00510 00514 class KIO_EXPORT MetaData : public TQMap<TQString, TQString> 00515 { 00516 public: 00520 MetaData() : TQMap<TQString, TQString>() { }; 00524 MetaData(const TQMap<TQString, TQString>&metaData) : 00525 TQMap<TQString, TQString>(metaData) { }; 00526 00532 MetaData & operator+= ( const TQMap<TQString,TQString> &metaData ) 00533 { 00534 TQMap<TQString,TQString>::ConstIterator it; 00535 for( it = metaData.begin(); 00536 it != metaData.end(); 00537 ++it) 00538 { 00539 replace(it.key(), it.data()); 00540 } 00541 return *this; 00542 } 00543 }; 00544 00545 } 00546 #endif