UploadgramPyAPI.py

"""
********************************
*------------------------------*
*--------UploadgramPyAPI-------*
*------------------------------*
********************************
Author: tankalxat34
Description: 
    This API can be upload, download, remove and rename any files from the service uploadgram.me.
Important links:
    - Uploadgram.me link: https://uploadgram.me/
    - Terms of Service: https://uploadgram.me/terms.html
    - DMCA Policy: https://uploadgram.me/dmca.html
Contacts (API Author):
    - github: https://github.com/tankalxat34/UploadgramPyAPI
    - email: mailto:tankalxat34@gmail.com?subject=User%20of%20UploadgramPyAPI
    - telegram: https://t.me/tankalxat34
Contacts (Uploadgram Author):
    - telegram channel: https://t.me/uploadgramme
    - telegram author: https://t.me/pato05
Other links:
    - pypi link: https://pypi.org/project/uploadgrampyapi/
    - pepy.tech statistic: https://pepy.tech/project/UploadgramPyAPI

****************************************************************
*----------------------Example of use:-------------------------*
****************************************************************

import UploadgramPyAPI

# Upload any file
up_new_file = UploadgramPyAPI.NewFile("D:\\image.jpg")
up_new_file.upload()

# Set up connection to file like here
up_file = UploadgramPyAPI.File("611e5e6237f6fg", "e3da26e9dddd2e01b8c0831370695e9088a96ff81e262fc2g")
# or like here
# up_file = UploadgramPyAPI.File("e3da26e9dddd2e01b8c0831370695e9088a96ff81e262fc2g")
# or like this
# up_file = UploadgramPyAPI.File("611e5e6237f6fg")

# Download any file
up_file.download()

# Rename any file
up_file.rename("ItsNewNameForFile.jpg")

# Delete any file
up_file.delete()

****************************************************************
"""
import random
import getpass
import json
import os
import os.path
import requests

# You can replace this user-agent any different
global USER_AGENT
USER_AGENT = "Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US) AppleWebKit/523.15 (KHTML, like Gecko, Safari/419.3) Arora/0.2"

# If you don't want to rename or delete the file you can use this const for param "key" in class "File"
global NONE
NONE = "none"

# Const for default length of 'id' parameter
global LENGTH_ID
LENGTH_ID = 14

# Const for default length of 'key' parameter
global LENGTH_KEY
LENGTH_KEY = 49


class UploadgramConnectionError(Exception):
    def __init__(self):
        super().__init__("Uploadgram.me currently unavailable. Please, try again later.")


class UploadgramUsingKeyError(Exception):
    def __init__(self, text):
        super().__init__('You can not ' + text + ' this file because you using the NONE-const for "key" parameter or you using "id" file instead of "key" parameter')


class UploadgramInvalidKey(Exception):
    def __init__(self, text):
        super().__init__("Invalid key to " + text + " this file")


class UploadgramFileIsNotAvalible(Exception):
    def __init__(self, id):
        super().__init__("This file " + id + " does not exists")


class UploadgramInvalidValue(Exception):
    def __init__(self, value, parameter):
        super().__init__('Invalid value "' + value + '" for parameter "' + parameter + '"')


class UploadgramInvalidLengthPattern(Exception):
    def __init__(self, pattern_name, length):
        super().__init__('Invalid length ' + str(length) + " for " + pattern_name)


class ServiceRules:
    def __init__(self, type="policies"):
        """Class for getting text from `Terms of Service` and `DMCA Policy`

        :param type:    Get string values: "policies" or "dmca"
        """
        self.req = requests.get("https://uploadgram.me/"+type+".txt", headers={"user-agent": USER_AGENT})
        if self.req:
            self.text = self.req.text
        else:
            if self.req.status_code == 404:
                raise UploadgramInvalidValue(type, "type")
            else:
                raise UploadgramConnectionError()

    def get(self): 
        return self.text


class Random:
    def __init__(self, type="id", pattern_id="62"+11*"."+"g", pattern_key=48*"."+"g", place_for_symbol="."):
        """Class for generate random key and id

        :param type:                String parameter, that you want to get: "id" or "key"
        :param pattern_id:          String pattern, that are using to generate file id
        :param pattern_key:         String pattern, that are using to generate file key
        :param place_for_symbol:    Any symbol that will be replaced on a random symbol
        """
        if type == "id" or type == "key":
            self.type = type
        else:
            raise UploadgramInvalidValue(type, "type")
        if len(pattern_id) != LENGTH_ID:
            raise UploadgramInvalidLengthPattern("pattern_id", len(pattern_id))
        if len(pattern_key) != LENGTH_KEY:
            raise UploadgramInvalidLengthPattern("pattern_key", len(pattern_key))
        if self.type == "id":
            self.using_pattern = pattern_id
        else:
            self.using_pattern = pattern_key
        self.pattern_id = pattern_id
        self.pattern_key = pattern_key
        self.length = len(self.using_pattern)
        self.place_for_symbol = place_for_symbol
        self.local_result = ""

    def get(self):
        """Returns random string for `key` or `id` parameter"""
        self.local_result = self.using_pattern
        for i in range(self.length):
            if self.using_pattern[i] == self.place_for_symbol:
                self.local_result = self.local_result.replace(self.place_for_symbol, hex(random.randint(0, 15))[2:], 1)
        return self.local_result

    def get_url(self):
        return "https://dl.uploadgram.me/" + self.get()


class File:
    def __init__(self, id: str, key=NONE):
        """
        :param id:  Get id file that placed at the end URL for file
        :param key: Key for rename and remove file from server
        """
        self.id = id
        if len(self.id) > LENGTH_ID:
            self.key = self.id
        else:
            self.key = key

        self.url_import = None

        try:
            self.r = requests.get("https://api.uploadgram.me/get/" + self.id)
        except requests.exceptions.ConnectionError:
            raise UploadgramConnectionError()

        if self.r:
            self.json = self.r.json()

            self.id = self.json["url"].split("/")[-1]
            self.url = "https://dl.uploadgram.me/" + self.id

            ### Create attibutes for class ###
            self.name = self.json["filename"]
            self.size = self.json["size"]
            self.scanned = self.json["wasScanned"]

            try:
                self.userTelegramId = self.json["userTelegramId"]
            except Exception:
                self.userTelegramId = None

            try:
                self.userIp = self.json["userIp"]
            except Exception:
                self.userIp = None

            if str(self.key) != NONE and len(self.key) > LENGTH_ID:
                ### Create import link ###
                dict_part_url_to_import = ({str(self.key): {'filename': os.path.basename(self.name),
                                                               'size': int(self.size),
                                                               'url': str(self.url)}})
                self.url_import = "https://uploadgram.me/upload/#import:" + json.dumps(dict_part_url_to_import)
            else:
                self.url_import = None
        else:
            raise UploadgramFileIsNotAvalible(self.id)

    def get_json(self):
        """
        Returns json response from answer
        """
        return self.json

    def download(self, path=f"C:\\Users\\{getpass.getuser()}\\Downloads\\"):
        """
        Returns True if the file was download on your PC
        """
        with open(path + self.name, 'wb') as f:
            f.write((requests.get(self.url + "?raw")).content)
        return True

    def delete(self):
        """
        Returns response from server if file deleted successfully
        """
        if self.key != NONE:
            self.r_delete = requests.get("https://api.uploadgram.me/delete/" + self.key,
                                     headers={"user-agent": USER_AGENT})
        else:
            raise UploadgramUsingKeyError("delete")
        if self.r_delete:
            return self.r_delete
        else:
            raise UploadgramInvalidKey("delete")

    def rename(self, new_name: str):
        """
        Returns response from server if file renamed successfully
        """
        if self.key != NONE:
            self.r_rename = requests.post("https://api.uploadgram.me/rename/" + self.key,
                                      data={"new_filename": new_name,
                                            "user-agent": USER_AGENT})
        else:
            raise UploadgramUsingKeyError("rename")
        if self.r_rename:
            return self.r_rename
        else:
            raise UploadgramInvalidKey("rename")


class NewFile:
    def __init__(self, path):
        """
        :param path:    Path to file what you want to upload
        """
        try:
            self.check_to_available = requests.get("https://api.uploadgram.me/status", headers={"user-agent": USER_AGENT})
            self.path = path
            self.url_upload = 'https://api.uploadgram.me/upload'
            self.readfile = open(self.path, "rb")

            self.key = None
            self.id = None
            self.url = None
            self.url_import = None

            self.name = None
            self.size = None
            self.scanned = None
            self.userTelegramId = None
            self.userIp = None
        except Exception:
            raise UploadgramConnectionError()

    def upload(self):
        """return {'ok': True, 'url': 'https://dl.uploadgram.me/new_file_id', 'delete': 'delete_key'}"""
        self.r = requests.post(self.url_upload,
                               headers={"user-agent": USER_AGENT},
                               files={"file_upload": self.readfile})
        self.key = self.r.json()["delete"]
        self.id = self.r.json()["url"].split("/")[-1]
        self.url = self.r.json()["url"]

        _local = File(self.id, self.key)
        self.url_import = _local.url_import

        self.name = _local.json["filename"]
        self.size = _local.json["size"]
        self.scanned = _local.json["wasScanned"]

        try:
            self.userTelegramId = _local.json["userTelegramId"]
        except Exception:
            pass

        try:
            self.userIp = _local.json["userIp"]
        except Exception:
            pass

        return self.r.json()