1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474
|
/***************************************************************************
smb4kglobal - This is the global namespace for Smb4K.
-------------------
begin : Sa Apr 2 2005
copyright : (C) 2005-2017 by Alexander Reinholdt
email : alexander.reinholdt@kdemail.net
***************************************************************************/
/***************************************************************************
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
* This program is distributed in the hope that it will be useful, but *
* WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
* General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program; if not, write to the *
* Free Software Foundation, Inc., 51 Franklin Street, Suite 500, Boston,*
* MA 02110-1335, USA *
***************************************************************************/
#ifndef SMB4KGLOBAL_H
#define SMB4KGLOBAL_H
// Qt includes
#include <QtCore/QMap>
#include <QtCore/QString>
#include <QtCore/QList>
#include <QtCore/QEvent>
#include <QtCore/QStringList>
// KDE includes
#include <kdemacros.h>
// forward declarations
class Smb4KWorkgroup;
class Smb4KHost;
class Smb4KShare;
/**
* This is the global namespace. It provides access to the global lists
* of workgroups, hosts and shares, to the global settings of the Samba
* configuration and much more.
*
* @author Alexander Reinholdt <alexander.reinholdt@kdemail.net>
*/
namespace Smb4KGlobal
{
/**
* The Process enumeration.
*
* @enum LookupDomains Look up domains
* @enum LookupDomainMembers Look up those servers that belong to a domain/workgroup
* @enum LookupShares Look up shares on a server
* @enum LookupInfo Lookup additional info about a server
* @enum WakeUp Send magic Wake-On-LAN packages
* @enum MountShare Mount a share
* @enum UnmountShare Unmount a share
*/
enum Process {
LookupDomains,
LookupDomainMembers,
LookupShares,
LookupInfo,
WakeUp,
MountShare,
UnmountShare };
/**
* The enumeration to determine the type of a network item.
*
* @enum Network the network
* @enum Workgroup a workgroup
* @enum Host a host
* @enum Share a share
* @enum Unknown an unknown network item
*/
enum NetworkItem {
Network,
Workgroup,
Host,
Share,
Unknown };
/**
* This class extends the QEvent class with Smb4K specific events
*/
class KDE_EXPORT Smb4KEvent : public QEvent
{
public:
static const QEvent::Type LoadSettings;
static const QEvent::Type SetFocus;
static const QEvent::Type ScanNetwork;
static const QEvent::Type AddBookmark;
static const QEvent::Type MountOrUnmountShare;
explicit Smb4KEvent( QEvent::Type type );
~Smb4KEvent();
};
/**
* Use this function to initialize the core classes. Besides starting several
* core classes such as the scanner (for an initial browse list) and the mounter
* (for the import of all externally mounted shares), it also sets some default
* values for some of the settings used to browse the network.
*
* By setting the @p modifyCursor parameter to TRUE, you force the core classes
* to set a busy cursor when they do something. Default is FALSE.
*
* Setting @p initClasses to FALSE will avoid starting the core classes. This
* should only the used if you are starting the core classes in a different
* way (e. g. if you are starting them in the plasmoid via the Smb4KDeclarative
* class).
*
* You should execute this function before starting your main application.
*/
KDE_EXPORT void initCore(bool modifyCursor = false, bool initClasses = true);
/**
* Aborts all actions that are run by the core classes and that can be aborted.
*/
KDE_EXPORT void abortCore();
/**
* Check if at least one of the core classes that use KJobs (scanner, mounter, etc.)
* is running.
*
* @returns TRUE if at least one of the core classes is doing something.
*/
KDE_EXPORT bool coreIsRunning();
/**
* Set the necessary default values.
*
* You only need to run this function if you do not use the initCore() function.
* Check if the core has been initialized by the coreIsInitialized() function.
*/
KDE_EXPORT void setDefaultSettings();
/**
* Check if the core has been initialized through the initCore() function.
*
* @returns TRUE if the core has already been initialized.
*/
KDE_EXPORT bool coreIsInitialized();
/**
* This function returns the global list of workgroups that were discovered by
* Smb4K. Use this if you want to access and modify the list with your code.
*
* @returns the global list of known workgroups.
*/
KDE_EXPORT const QList<Smb4KWorkgroup *> &workgroupsList();
/**
* This function returns the workgroup or domain that matches the name @p name or
* NULL if there is no such workgroup.
*
* @returns a pointer to the workgroup with name @p name.
*/
KDE_EXPORT Smb4KWorkgroup *findWorkgroup( const QString &name );
/**
* This function takes a workgroup @p workgroup, checks whether it is already
* in the list of domains and adds it to the list if necessary. It returns TRUE
* if the workgroup was added and FALSE otherwise.
*
* Please prefer this function over per class solutions.
*
* @param workgroup The workgroup item
*
* @returns TRUE if the workgroup was added and FALSE otherwise.
*/
KDE_EXPORT bool addWorkgroup( Smb4KWorkgroup *workgroup );
/**
* This function removes a workgroup @p workgroup from the list of domains. The
* pointer that is passed to this function will be deleted. You won't be able
* to use it afterwards. This function returns TRUE if the workgroup was removed
* and FALSE otherwise.
*
* Please prefer this function over per class solutions.
*
* @param workgroup The workgroup item
*
* @returns TRUE if the workgroup was removed and FALSE otherwise.
*/
KDE_EXPORT bool removeWorkgroup( Smb4KWorkgroup *workgroup );
/**
* This function clears the global list of workgroups.
*/
KDE_EXPORT void clearWorkgroupsList();
/**
* This function returns the global list of hosts that were discovered by
* Smb4K. Use this if you want to access and modify the list with your code.
*
* @returns the global list of known hosts.
*/
KDE_EXPORT const QList<Smb4KHost *> &hostsList();
/**
* This function returns the host matching the name @p name or NULL if there is no
* such host. The name of the host is mandatory. The workgroup may be empty, but
* should be given, because this will speed up the search process.
*
* @param name The name of the host
*
* @param workgroup The workgroup where the host is located
*
* @returns an Smb4KHost item of NULL if none was found that matches @p name.
*/
KDE_EXPORT Smb4KHost *findHost( const QString &name,
const QString &workgroup = QString() );
/**
* This function takes a host @p host, checks whether it is already
* in the list of hosts and adds it to the list if necessary. It returns TRUE
* if the host was added and FALSE otherwise.
*
* Please prefer this function over per class solutions.
*
* @param host The host item
*
* @returns TRUE if the host was added and FALSE otherwise.
*/
KDE_EXPORT bool addHost( Smb4KHost *host );
/**
* This function removes a host @p host from the list of hosts. The
* pointer that is passed to this function will be deleted. You won't
* be able to use it afterwards. This function returns TRUE if the host was removed
* and FALSE otherwise.
*
* Please prefer this function over per class solutions.
*
* @param host The host item
*
* @returns TRUE if the host was removed and FALSE otherwise.
*/
KDE_EXPORT bool removeHost( Smb4KHost *host );
/**
* This function clears the global list of hosts.
*/
KDE_EXPORT void clearHostsList();
/**
* This function returns all hosts that belong to the workgroup or domain
* @p workgroup.
*
* Please favor this function over per class solutions.
*
* @param workgroup The workgroup for that the list should be returned.
*
* @returns the list of hosts belonging to the workgroup or domain @param workgroup.
*/
KDE_EXPORT QList<Smb4KHost *> workgroupMembers( Smb4KWorkgroup *workgroup );
/**
* This function returns the list of shares that were discovered by Smb4K.
* Use this if you want to access and modify the list with your code.
*
* @returns the global list of known shares.
*/
KDE_EXPORT const QList<Smb4KShare *> &sharesList();
/**
* This function returns the share located at host @p host matching the name
* @p name or NULL if there is no such share. The name of the share and host
* are mandatory. The workgroup entry may be empty.
*
* @param name The name of the share
*
* @param host The name of the host
*
* @param workgroup The name of the workgroup
*
* @returns an Smb4KShare item of NULL if none was found that matches @p name
* and @p host.
*/
KDE_EXPORT Smb4KShare *findShare( const QString &name,
const QString &host,
const QString &workgroup = QString() );
/**
* This function takes a share @p share, checks whether it is already
* in the list of shares and adds it to the list if necessary. It returns TRUE
* if the share was added and FALSE otherwise.
*
* Please prefer this function over per class solutions.
*
* @param share The share item
*
* @returns TRUE if the share was added and FALSE otherwise.
*/
KDE_EXPORT bool addShare( Smb4KShare *share );
/**
* This function removes a share @p share from the list of shares. The
* pointer that is passed to this function will be deleted. You won't
* be able to use it afterwards. This function returns TRUE if the share was removed
* and FALSE otherwise.
*
* Please prefer this function over per class solutions.
*
* @param share The share item
*
* @returns TRUE if the share was removed and FALSE otherwise.
*/
KDE_EXPORT bool removeShare( Smb4KShare *share );
/**
* This function clears the global list of shares.
*/
KDE_EXPORT void clearSharesList();
/**
* This function returns the list of shares that is provided by one specific host
* @p host.
*
* Please favor this function over per class solutions.
*
* @param host The host where the shares are located
*
* @returns the list of shares that are provided by the host @p host.
*/
KDE_EXPORT QList<Smb4KShare *> sharedResources( Smb4KHost *host );
/**
* This function returns the global list of mounted shares that were discovered by
* Smb4K. Use this if you want to access and modify the list with your code.
*
* @returns the global list of known mounted shares.
*/
KDE_EXPORT const QList<Smb4KShare *> &mountedSharesList();
/**
* Find a mounted share by its path (i.e. mount point).
*
* @returns the share that is mounted to @p path.
*/
KDE_EXPORT Smb4KShare *findShareByPath( const QString &path );
/**
* Find all mounts of a particular share with UNC @p unc on the system.
*
* This function will compare the incoming string with the UNC of each
* mounted share to find all shares with the same UNC. For the comparison
* the scheme/protocol, the user info, and the port will be stripped. You
* can pass the UNC in any valid format. The function will internally
* convert the string into a QUrl and work with that.
*
* @param unc The UNC of the share
*
* @returns the complete list of mounts with the UNC @p unc.
*/
KDE_EXPORT QList<Smb4KShare *> findShareByUNC( const QString &unc );
/**
* This function returns the list of inaccessible shares.
*
* @returns the list of inaccessible shares.
*/
KDE_EXPORT QList<Smb4KShare *> findInaccessibleShares();
/**
* This function takes a mounted share @p share, checks whether it is
* already in the list of mounted shares and adds it to the list if
* necessary. It returns TRUE if the share was added and FALSE otherwise.
*
* Please prefer this function over per class solutions.
*
* @param share The share item
*
* @returns TRUE if the share was added and FALSE otherwise.
*/
KDE_EXPORT bool addMountedShare( Smb4KShare *share );
/**
* This function removes a mounted share @p share from the list of mounted
* shares. The pointer that is passed to this function will be deleted.
* You won't be able to use it afterwards. This function returns TRUE if
* the share was removed and FALSE otherwise.
*
* Please prefer this function over per class solutions.
*
* @param share The share item
*
* @returns TRUE if the share was removed and FALSE otherwise.
*/
KDE_EXPORT bool removeMountedShare( Smb4KShare *share );
/**
* This function returns TRUE if only shares are present that are owned by
* other users and FALSE otherwise.
*
* @returns TRUE if there are only shares that are owned by other users.
*/
KDE_EXPORT bool onlyForeignMountedShares();
/**
* This enumeration determines with which application the mount point
* of the current mounted share is to be opened.
*/
enum OpenWith { FileManager,
Konsole };
/**
* Open the mount point of a share. Which application is used is determined by
* the value of @p openWith and - maybe - by settings that were defined by the
* user.
*
* @param share The share that is to be opened.
*
* @param openWith Integer of type Smb4KCore::OpenWith. Determines with which
* application the share should be opened.
*/
KDE_EXPORT void openShare( Smb4KShare *share, OpenWith openWith = FileManager );
/**
* Get the entries of the [global] section of the smb.conf file. By setting @p read
* to TRUE you can force the smb.conf file to be reread.
*
* @returns the entries of the [global] section of the smb.conf file
*/
KDE_EXPORT const QMap<QString,QString> &globalSambaOptions( bool read = false );
/**
* Get the WINS server's name or IP address. Returns an empty string if there is no
* WINS server is defined.
*
* @returns the WINS server
*/
KDE_EXPORT const QString winsServer();
/**
* This function returns TRUE if the core classes should set a busy cursor when
* they are doing something.
*
* @returns TRUE in case a busy cursor should be set.
*/
KDE_EXPORT bool modifyCursor();
#ifdef Q_OS_LINUX
/**
* This list contains all whitelisted arguments for the mount.cifs binary and
* is only present under the Linux operatin system.
*/
KDE_EXPORT QStringList whitelistedMountArguments();
#endif
/**
* Find the mount executable on the system.
*
* @returns the path of the mount executable.
*/
KDE_EXPORT const QString findMountExecutable();
/**
* Find the umount executable on the system.
*
* @returns the path of the umount executable.
*/
KDE_EXPORT const QString findUmountExecutable();
};
#endif
|