file.h

/*
    Copyright 2012  Andrius da Costa Ribas <[email protected]>

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    version 2.1 of the License, or (at your option) version 3, or any
    later version accepted by the membership of KDE e.V. (or its
    successor approved by the membership of KDE e.V.), which shall
    act as a proxy defined in Section 6 of version 3 of the license.

    This library 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 Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public
    License along with this library.  If not, see <https://www.gnu.org/licenses/>.
*/

#ifndef LIBKGAPI2_DRIVEFILE_H
#define LIBKGAPI2_DRIVEFILE_H

#include "object.h"
#include "types.h"
#include "change.h"

#include <QString>
#include <QStringList>
#include <QUrl>
#include <QVariantMap>
#include <QImage>

#include <QDateTime>

namespace KGAPI2
{

namespace Drive
{

class KGAPIDRIVE_EXPORT File: public KGAPI2::Object
{
  private:
    class Private;

  public:
    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); }

        bool starred() const;

        void setStarred(bool starred);

#ifndef KGAPIDRIVE_NO_DEPRECATED
        KGAPIDRIVE_DEPRECATED bool hidden() const;
#endif

#ifndef KGAPIDRIVE_NO_DEPRECATED
        KGAPIDRIVE_DEPRECATED void setHidden(bool hidden);
#endif

        bool trashed() const;

        void setTrashed(bool trashed);

        bool restricted() const;

        void setRestricted(bool restricted);

        bool viewed() const;

        void setViewed(bool viewed);

      private:
        class Private;
        Private *const d;
        friend class Private;
        friend class File::Private;
    };

    typedef QSharedPointer<Labels> LabelsPtr;
    typedef QList<LabelsPtr> LabelsList;

    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); }

        QString text() const;

        void setText(const QString &text);

      private:
        explicit IndexableText();

        class Private;
        Private *const d;
        friend class Private;
        friend class File::Private;
    };

    typedef QSharedPointer<IndexableText> IndexableTextPtr;

    class ImageMediaMetadata
    {
      public:
        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); }

            qreal latitude() const;

            qreal longitude() const;

            qreal altitude() const;

          private:
            explicit Location();

            class Private;
            Private *const d;
            friend class Private;
            friend class ImageMediaMetadata;
        };

        typedef QSharedPointer<Location> LocationPtr;

        explicit ImageMediaMetadata(const ImageMediaMetadata &other);
        virtual ~ImageMediaMetadata();
        bool operator==(const ImageMediaMetadata &other) const;
        bool operator!=(const ImageMediaMetadata &other) const { return !operator==(other); }

        int width() const;

        int height() const;

        int rotation() const;

        LocationPtr location() const;

        QString date() const;

        QString cameraMake() const;

        QString cameraModel() const;

        float exposureTime() const;

        float aperture()  const;

        bool flashUsed() const;

        float focalLength() const;

        int isoSpeed() const;

        QString meteringMode() const;

        QString sensor() const;

        QString exposureMode() const;

        QString colorSpace() const;

        QString whiteBalance() const;

        float exposureBias() const;

        float maxApertureValue() const;

        int subjectDistance() const;

        QString lens() const;

      private:
        explicit ImageMediaMetadata(const QVariantMap &jsonMap);

        class Private;
        Private *const d;
        friend class Private;
        friend class File::Private;
    };

    typedef QSharedPointer<ImageMediaMetadata> ImageMediaMetadataPtr;

    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); }

        QImage image() const;

        QString mimeType() const;

      private:
        explicit Thumbnail(const QVariantMap &jsonMap);

        class Private;
        Private * const d;
        friend class Private;
        friend class File::Private;
    };

    typedef QSharedPointer<Thumbnail> ThumbnailPtr;

    enum SerializationOption {
        NoOptions = 0,             
        ExcludeCreationDate = 1    
    };
    Q_DECLARE_FLAGS(SerializationOptions, SerializationOption)

    explicit File();
    explicit File(const File &other);
    virtual ~File();
    bool operator==(const File &other) const;
    bool operator!=(const File &other) const { return !operator==(other); }

    static QString folderMimeType();

    QString id() const;

    QUrl selfLink() const;

    QString title() const;

    void setTitle(const QString &title);

    QString mimeType() const;

    void setMimeType(const QString &mimeType);

    QString description() const;

    void setDescription(const QString &description);

    File::LabelsPtr labels() const;

    void setLabels(const LabelsPtr &labels);

    QDateTime createdDate() const;

    QDateTime modifiedDate() const;

    void setModifiedDate(const QDateTime &modifiedDate);

    QDateTime modifiedByMeDate() const;

    QUrl downloadUrl() const;

    File::IndexableTextPtr& indexableText();

    PermissionPtr userPermission() const;

    QString fileExtension() const;

    QString md5Checksum() const;

    qlonglong fileSize() const;

    QUrl alternateLink() const;

    QUrl embedLink() const;

    QDateTime sharedWithMeDate() const;

    ParentReferencesList parents() const;

    void setParents(const ParentReferencesList &parents);

    QMap < QString /* format */, QUrl /* url */ > exportLinks() const;

    QString originalFileName() const;

    qlonglong quotaBytesUsed() const;

    QStringList ownerNames() const;

    QString lastModifyingUserName() const;

    bool editable() const;

    bool writersCanShare() const;

    QUrl thumbnailLink() const;

    QDateTime lastViewedByMeDate() const;

    void setLastViewedByMeDate(const QDateTime &lastViewedByMeDate);

    QUrl webContentLink() const;

    bool explicitlyTrashed() const;

    File::ImageMediaMetadataPtr imageMediaMetadata() const;

    ThumbnailPtr thumbnail() const;

    QUrl webViewLink() const;

    QUrl iconLink() const;

    bool shared() const;

    UsersList owners() const;

    UserPtr lastModifyingUser() const;

    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)

#endif // LIBKGAPI2_DRIVEFILE_H