File indexing completed on 2024-05-12 05:22:19

 /*
     SPDX-FileCopyrightText: 2012 Andrius da Costa Ribas <andriusmao@gmail.com>
 
     SPDX-License-Identifier: LGPL-2.1-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
 */
 
 #pragma once
 
 #include "change.h"
 #include "object.h"
 #include "types.h"
 
 #include <QImage>
 #include <QString>
 #include <QStringList>
 #include <QUrl>
 #include <QVariantMap>
 
 #include <QDateTime>
 
 namespace KGAPI2
 {
 
 namespace Drive
 {
 
 /**
  * @brief File contains metadata for a file.
  * Getters and setters' documentation is based on Google Drive's API v2 reference
  * @see <a href="https://developers.google.com/drive/v2/reference/files">Files</a>
  *
  * @since 2.0
  * @author Andrius da Costa Ribas <andriusmao@gmail.com>
  * @author Daniel Vrátil <dvratil@redhat.com>
  */
 class KGAPIDRIVE_EXPORT File : public KGAPI2::Object
 {
 private:
     class Private;
 
 public:
     /**
      * @brief DriveFile::Labels holds the structure used for labels property.
      */
     class Labels
     {
     public:
         explicit Labels();
         explicit Labels(const Labels &other);
         virtual ~Labels();
         bool operator==(const Labels &other) const;
         bool operator!=(const Labels &other) const
         {
             return !operator==(other);
         }
 
         /**
          * @brief Returns whether this file is starred by the user.
          */
         [[nodiscard]] bool starred() const;
 
         /**
          * @brief Sets whether this file is starred by the user.
          *
          * @param starred
          */
         void setStarred(bool starred);
 
         /**
          * @brief Returns whether this file has the 'hidden' label set.
          * @deprecated The 'hidden' label has been deprecated in the v2 api and removed in the v3 one.
          *             You can just ignore it.
          */
 #ifndef KGAPIDRIVE_NO_DEPRECATED
         KGAPIDRIVE_DEPRECATED bool hidden() const;
 #endif
 
         /**
          * @brief Sets whether this file has the 'hidden' label set.
          * @deprecated The 'hidden' label has been deprecated in the v2 api and removed in the v3 one.
          */
 #ifndef KGAPIDRIVE_NO_DEPRECATED
         KGAPIDRIVE_DEPRECATED void setHidden(bool hidden);
 #endif
 
         /**
          * @brief Returns whether this file has been trashed.
          */
         bool trashed() const;
 
         /**
          * @brief Sets whether this file has been trashed.
          *
          * @param trashed
          */
         void setTrashed(bool trashed);
 
         /**
          * @brief Returns whether viewers are prevented from downloading this file.
          */
         bool restricted() const;
 
         /**
          * @brief Sets whether viewers are prevented from downloading this file.
          *
          * @param restricted
          */
         void setRestricted(bool restricted);
 
         /**
          * @brief Returns whether this file has been viewed by this user.
          */
         [[nodiscard]] bool viewed() const;
 
         /**
          * @brief Sets whether this file has been viewed by this user.
          *
          * @param viewed
          */
         void setViewed(bool viewed);
 
     private:
         class Private;
         Private *const d;
         friend class Private;
         friend class File::Private;
     };
 
     using LabelsPtr = QSharedPointer<Labels>;
     using LabelsList = QList<LabelsPtr>;
 
     /**
      * @brief DriveFile::IndexableText holds the structure used for indexableText property.
      */
     class IndexableText
     {
     public:
         explicit IndexableText(const IndexableText &other);
         virtual ~IndexableText();
         bool operator==(const IndexableText &other) const;
         bool operator!=(const IndexableText &other) const
         {
             return !operator==(other);
         }
 
         /**
          * @brief Returns the text to be indexed for this file.
          */
         [[nodiscard]] QString text() const;
 
         /**
          * @brief Sets the text to be indexed for this file.
          *
          * @param text
          */
         void setText(const QString &text);
 
     private:
         explicit IndexableText();
 
         class Private;
         Private *const d;
         friend class Private;
         friend class File::Private;
     };
 
     using IndexableTextPtr = QSharedPointer<IndexableText>;
 
     /**
      * @brief DriveFile::ImageMediaMetadata holds the structure used for
      *        imageMediaMetadata property.
      */
     class ImageMediaMetadata
     {
     public:
         /**
          * @brief DriveFile::ImageMediaMetadata::Location holds the structure used
          *        for imageMediaMetadata.location property.
          */
         class Location
         {
         public:
             explicit Location(const Location &other);
             virtual ~Location();
             bool operator==(const Location &other) const;
             bool operator!=(const Location &other) const
             {
                 return !operator==(other);
             }
 
             /**
              * @brief Returns the latitude stored in the image.
              */
             [[nodiscard]] qreal latitude() const;
 
             /**
              * @brief Returns the longitude stored in the image.
              */
             [[nodiscard]] qreal longitude() const;
 
             /**
              * @brief Returns the altitude stored in the image.
              */
             [[nodiscard]] qreal altitude() const;
 
         private:
             explicit Location();
 
             class Private;
             Private *const d;
             friend class Private;
             friend class ImageMediaMetadata;
         };
 
         using LocationPtr = QSharedPointer<Location>;
 
         explicit ImageMediaMetadata(const ImageMediaMetadata &other);
         virtual ~ImageMediaMetadata();
         bool operator==(const ImageMediaMetadata &other) const;
         bool operator!=(const ImageMediaMetadata &other) const
         {
             return !operator==(other);
         }
 
         /**
          * @brief Returns the width of the image in pixels.
          */
         [[nodiscard]] int width() const;
 
         /**
          * @brief Returns the height of the image in pixels.
          */
         [[nodiscard]] int height() const;
 
         /**
          * @brief Returns the rotation in clockwise degrees from the image's original orientation.
          */
         [[nodiscard]] int rotation() const;
 
         /**
          * @brief Returns the geographic location information stored in the image.
          */
         [[nodiscard]] LocationPtr location() const;
 
         [[nodiscard]] QString date() const;
 
         [[nodiscard]] QString cameraMake() const;
 
         [[nodiscard]] QString cameraModel() const;
 
         [[nodiscard]] float exposureTime() const;
 
         [[nodiscard]] float aperture() const;
 
         [[nodiscard]] bool flashUsed() const;
 
         [[nodiscard]] float focalLength() const;
 
         [[nodiscard]] int isoSpeed() const;
 
         [[nodiscard]] QString meteringMode() const;
 
         [[nodiscard]] QString sensor() const;
 
         [[nodiscard]] QString exposureMode() const;
 
         [[nodiscard]] QString colorSpace() const;
 
         [[nodiscard]] QString whiteBalance() const;
 
         [[nodiscard]] float exposureBias() const;
 
         [[nodiscard]] float maxApertureValue() const;
 
         [[nodiscard]] int subjectDistance() const;
 
         [[nodiscard]] QString lens() const;
 
     private:
         explicit ImageMediaMetadata(const QVariantMap &jsonMap);
 
         class Private;
         Private *const d;
         friend class Private;
         friend class File::Private;
     };
 
     using ImageMediaMetadataPtr = QSharedPointer<ImageMediaMetadata>;
 
     class Thumbnail
     {
     public:
         explicit Thumbnail(const Thumbnail &other);
         virtual ~Thumbnail();
         bool operator==(const Thumbnail &other) const;
         bool operator!=(const Thumbnail &other) const
         {
             return !operator==(other);
         }
 
         [[nodiscard]] QImage image() const;
 
         [[nodiscard]] QString mimeType() const;
 
     private:
         explicit Thumbnail(const QVariantMap &jsonMap);
 
         class Private;
         Private *const d;
         friend class Private;
         friend class File::Private;
     };
 
     using ThumbnailPtr = QSharedPointer<Thumbnail>;
 
     /**
      * @brief JSON serialization options.
      * @since 5.3.1
      */
     enum SerializationOption {
         NoOptions = 0, ///< No option set.
         ExcludeCreationDate = 1 ///< Exclude 'createdDate' entry. This is necessary when renaming URLs.
     };
     Q_DECLARE_FLAGS(SerializationOptions, SerializationOption)
 
     explicit File();
     explicit File(const File &other);
     ~File() override;
     bool operator==(const File &other) const;
     bool operator!=(const File &other) const
     {
         return !operator==(other);
     }
 
     /**
      * @brief Returns mimetype of folders
      */
     static QString folderMimeType();
 
     /**
      * @brief Returns the id of the file.
      */
     [[nodiscard]] QString id() const;
 
     /**
      * @brief Returns a link back to this file.
      */
     [[nodiscard]] QUrl selfLink() const;
 
     /**
      * @brief Returns the title of this file.
      *
      * Used to identify file or folder name.
      */
     [[nodiscard]] QString title() const;
 
     /**
      * @brief Sets the title of this file.
      *
      * Used to identify file or folder name.
      *
      * @param title
      */
     void setTitle(const QString &title);
 
     /**
      * @brief Returns the MIME type of the file.
      */
     [[nodiscard]] QString mimeType() const;
 
     /**
      * @brief Sets the MIME type of the file.
      *
      * @param mimeType
      */
     void setMimeType(const QString &mimeType);
 
     /**
      * @brief Returns a short description of the file.
      */
     [[nodiscard]] QString description() const;
 
     /**
      * @brief Sets a short description of the file.
      *
      * @param description
      */
     void setDescription(const QString &description);
 
     /**
      * @brief Returns a group of labels for the file.
      */
     File::LabelsPtr labels() const;
 
     /**
      * @brief Sets a group of labels for the file.
      *
      * @param labels
      */
     void setLabels(const LabelsPtr &labels);
 
     /**
      * @brief Returns the create time for this file.
      */
     [[nodiscard]] QDateTime createdDate() const;
 
     /**
      * @brief Returns the last time this file was modified by anyone.
      *
      * This is only mutable on update when the setModifiedDate parameter is set.
      */
     [[nodiscard]] QDateTime modifiedDate() const;
 
     /**
      * @brief Sets the last time this file was modified by anyone.
      *
      * This is only mutable on update when the setModifiedDate parameter is set.
      *
      * @param modifiedDate
      */
     void setModifiedDate(const QDateTime &modifiedDate);
 
     /**
      * @brief Returns the last time this file was modified by the currently
      *        authenticated user.
      */
     [[nodiscard]] QDateTime modifiedByMeDate() const;
 
     /**
      * @brief Returns a short lived download URL for the file.
      *
      * This is only populated for files with content stored in Drive.
      */
     [[nodiscard]] QUrl downloadUrl() const;
 
     /**
      * @brief Returns the indexable text attributes for the file.
      *
      * This property can only be written, and is not returned by files.get
      */
     File::IndexableTextPtr &indexableText();
 
     /**
      * @brief Returns the permissions for the authenticated user on this file.
      */
     PermissionPtr userPermission() const;
 
     /**
      * @brief Returns the file extension used when downloading this file.
      *
      * This field is read only. To set the extension, include it on title when creating the file.
      * This is populated only for files with content stored in Drive.
      */
     [[nodiscard]] QString fileExtension() const;
 
     /**
      * @brief Returns an MD5 checksum for the content of this file.
      *
      * This is populated only for files with content stored in Drive.
      */
     [[nodiscard]] QString md5Checksum() const;
 
     /**
      * @brief Returns the size of the file in bytes.
      *
      * This is populated only for files with content stored in Drive.
      */
     [[nodiscard]] qlonglong fileSize() const;
 
     /**
      * @brief Returns a link for opening the file in using a relevant
      *        Google editor or viewer.
      */
     [[nodiscard]] QUrl alternateLink() const;
 
     /**
      * @brief Returns a link for embedding the file.
      */
     [[nodiscard]] QUrl embedLink() const;
 
     /**
      * @brief Returns the version of the file;
      */
     [[nodiscard]] qlonglong version() const;
 
     /**
      * @brief Returns the time at which this file was shared with the user.
      */
     [[nodiscard]] QDateTime sharedWithMeDate() const;
 
     /**
      * @brief Returns the collection of parent folders which contain this file.
      *
      * Setting this field will put the file in all of the provided folders.
      * On insert, if no folders are provided, the file will be placed in the
      * default root folder.
      */
     ParentReferencesList parents() const;
 
     /**
      * @brief Sets the collection of parent folders which contain this file.
      *
      * Setting this field will put the file in all of the provided folders.
      * On insert, if no folders are provided, the file will be placed in the
      * default root folder.
      *
      * @param parents
      */
     void setParents(const ParentReferencesList &parents);
 
     /**
      * @brief Returns the links for exporting Google Docs to specific formats.
      *
      * This is a map from the export format to URL.
      */
     QMap<QString /* format */, QUrl /* url */> exportLinks() const;
 
     /**
      * @brief Returns the original filename if the file was uploaded manually,
      *        or the original title if the file was inserted through the API.
      *
      * Note that renames of the title will not change the original filename.
      * This will only be populated on files with content stored in Drive.
      */
     [[nodiscard]] QString originalFileName() const;
 
     /**
      * @brief Returns the number of quota bytes used by this file.
      */
     [[nodiscard]] qlonglong quotaBytesUsed() const;
 
     /**
      * @brief Return the name(s) of the owner(s) of this file.
      */
     [[nodiscard]] QStringList ownerNames() const;
 
     /**
      * @brief Returns the name of the last user to modify this file.
      *
      * This will only be populated if a user has edited this file.
      */
     [[nodiscard]] QString lastModifyingUserName() const;
 
     /**
      * @brief Returns whether the file can be edited by the current user.
      */
     [[nodiscard]] bool editable() const;
 
     /**
      * @brief Returns whether writers can share the document with other users.
      */
     [[nodiscard]] bool writersCanShare() const;
 
     /**
      * @brief Returns a link to the file's thumbnail.
      */
     [[nodiscard]] QUrl thumbnailLink() const;
 
     /**
      * @brief Returns the last time this file was viewed by the user.
      */
     [[nodiscard]] QDateTime lastViewedByMeDate() const;
 
     /**
      * @brief Sets the last time this file was viewed by the user.
      *
      * @param lastViewedByMeDate
      */
     void setLastViewedByMeDate(const QDateTime &lastViewedByMeDate);
 
     /**
      * @brief Returns a link for downloading the content of the file in a browser
      *        using cookie based authentication.
      *
      * In cases where the content is shared publicly, the content can be
      * downloaded without any credentials.
      */
     [[nodiscard]] QUrl webContentLink() const;
 
     /**
      * @brief Returns whether this file has been explicitly trashed, as opposed
      *        to recursively trashed.
      *
      * This will only be populated if the file is trashed.
      */
     [[nodiscard]] bool explicitlyTrashed() const;
 
     /**
      * @brief Returns metadata about image media.
      *
      * This will only be present for image types, and its contents will depend
      * on what can be parsed from the image content.
      */
     File::ImageMediaMetadataPtr imageMediaMetadata() const;
 
     /**
      * @brief Returns thumbnail for the file.
      */
     ThumbnailPtr thumbnail() const;
 
     [[nodiscard]] QUrl webViewLink() const;
 
     [[nodiscard]] QUrl iconLink() const;
 
     [[nodiscard]] bool shared() const;
 
     [[nodiscard]] UsersList owners() const;
 
     [[nodiscard]] UserPtr lastModifyingUser() const;
 
     [[nodiscard]] bool isFolder() const;
 
     struct Fields {
         static const QString Items;
         static const QString SelfLink;
         static const QString Etag;
         static const QString Kind;
         static const QString NextLink;
         static const QString NextPageToken;
         static const QString Id;
         static const QString Title;
         static const QString MimeType;
         static const QString Description;
         static const QString Labels;
         static const QString CreatedDate;
         static const QString ModifiedDate;
         static const QString ModifiedByMeDate;
         static const QString DownloadUrl;
         static const QString IndexableText;
         static const QString UserPermission;
         static const QString FileExtension;
         static const QString Md5Checksum;
         static const QString FileSize;
         static const QString AlternateLink;
         static const QString EmbedLink;
         static const QString SharedWithMeDate;
         static const QString Parents;
         static const QString ExportLinks;
         static const QString OriginalFilename;
         static const QString OwnerNames;
         static const QString LastModifiedByMeDate;
         static const QString Editable;
         static const QString WritersCanShare;
         static const QString ThumbnailLink;
         static const QString LastViewedByMeDate;
         static const QString WebContentLink;
         static const QString ExplicitlyTrashed;
         static const QString ImageMediaMetadata;
         static const QString Thumbnail;
         static const QString WebViewLink;
         static const QString IconLink;
         static const QString Shared;
         static const QString Owners;
         static const QString LastModifyingUser;
         static const QString AppDataContents;
         static const QString OpenWithLinks;
         static const QString DefaultOpenWithLink;
         static const QString HeadRevisionId;
         static const QString Copyable;
         static const QString Properties;
         static const QString MarkedViewedByMeDate;
         static const QString Version;
         static const QString SharingUser;
         static const QString Permissions;
     };
 
     static FilePtr fromJSON(const QByteArray &jsonData);
     static FilesList fromJSONFeed(const QByteArray &jsonData, FeedData &feedData);
     static QByteArray toJSON(const FilePtr &file, SerializationOptions options = NoOptions);
 
     static FilePtr fromJSON(const QVariantMap &jsonData);
 
 private:
     Private *const d;
     friend class Private;
     friend class Change::Private;
     friend class ParentReference;
     friend class Permission;
 };
 
 } /* namespace Drive */
 
 } /* namespace KGAPI2 */
 
 Q_DECLARE_OPERATORS_FOR_FLAGS(KGAPI2::Drive::File::SerializationOptions)