appwrite/src/Appwrite/Extend/Exception.php

<?php

namespace Appwrite\Extend;

use Utopia\Config\Config;

class Exception extends \Exception
{
    /**
     * Error Codes
     *  
     * Naming the error types based on the following convention 
     * <ENTITY>_<ERROR_TYPE>
     * 
     * Appwrite has the follwing entities:
     * - Users
     * - Projects
     * - Sessions
     * - Teams
     * - Memberships
     * - Files
     * - Functions
     * - Deployments
     * - Executions
     */

    /** Users */
    const USER_COUNT_EXCEEDED               = 'user_count_exceeded';
    const USER_ALREADY_EXISTS               = 'user_already_exists';
    const USER_BLOCKED                      = 'user_blocked';
    const USER_CREATION_FAILED              = 'user_creation_failed';
    const USER_INVALID_TOKEN                = 'user_invalid_token';
    const USER_NOT_FOUND                    = 'user_not_found';
    const USER_INVALID_CREDENTIALS          = 'user_invalid_credentials';
    const USER_EMAIL_ALREADY_EXISTS         = 'user_email_already_exists';
    const USER_PASSWORD_MISMATCH            = 'user_password_mismatch';
    const USER_AUTH_METHOD_UNSUPPORTED      = 'user_auth_method_unsupported';
    const USER_PASSWORD_RESET_REQUIRED      = 'user_password_reset_required';
    const USER_EMAIL_NOT_WHITELISTED        = 'user_email_not_whitelisted';
    const USER_IP_NOT_WHITELISTED           = 'user_ip_not_whitelisted';
    const USER_SESSION_ALREADY_EXISTS       = 'user_session_already_exists';
    const USER_SESSION_NOT_FOUND            = 'user_session_not_found';
    const USER_UNAUTHORIZED                 = 'user_unauthorized';
    const USER_ANONYMOUS_CONSOLE_PROHIBITED = 'user_anonymous_console_prohibited';

    /** OAuth **/
    const OAUTH_PROVIDER_DISABLED          = 'oauth_provider_disabled';
    const OAUTH_PROVIDER_UNSUPPORTED       = 'oauth_provider_unsupported';
    const OAUTH_INVALID_LOGIN_STATE_PARAMS = 'oauth_invalid_login_state_params';
    const OAUTH_INVALID_SUCCESS_URL        = 'oauth_invalid_success_url';
    const OAUTH_INVALID_FAILURE_URL        = 'oauth_invalid_failure_url';
    const OAUTH_ACCESS_TOKEN_FAILED        = 'oauth_access_token_failed';
    const OAUTH_MISSING_USER_ID            = 'oauth_missing_user_id';

    /** Teams */
    const TEAM_NOT_FOUND                 = 'team_not_found';
    const TEAM_DELETION_FAILED           = 'team_deletion_failed';
    const TEAM_INVITE_ALREADY_EXISTS     = 'team_invite_already_exists';
    const TEAM_INVITE_NOT_FOUND          = 'team_invite_not_found';
    const TEAM_INVALID_SECRET            = 'team_invalid_secret';
    const TEAM_MEMBERSHIP_MISMATCH       = 'team_membership_mismatch';
    const TEAM_INVITE_MISMATCH           = 'team_invite_mismatch'; 

    /** Membership */
    const MEMBERSHIP_NOT_FOUND       = 'membership_not_found';
    const MEMBERSHIP_DELETION_FAILED = 'membership_deletion_failed';

    /** Avatars */
    const AVATAR_SET_NOT_FOUND             = 'avatar_set_not_found';
    const AVATAR_NOT_FOUND                 = 'avatar_not_found';
    const IMAGIC_EXTENSION_MISSING         = 'imagic_extension_missing';
    const AVATAR_IMAGE_NOT_FOUND           = 'avatar_image_not_found';
    const AVATAR_CANNOT_PARSE_IMAGE        = 'avatar_cannot_parse_image';
    const AVATAR_REMOTE_URL_FAILED         = 'avatar_remote_url_failed';
    const AVATAR_ICON_NOT_FOUND            = 'avatar_icon_not_found';

    /** Storage */
    const STORAGE_FILE_NOT_FOUND            = 'storage_file_not_found';
    const STORAGE_DEVICE_NOT_FOUND          = 'storage_device_not_found';
    const STORAGE_FILE_DELETION_FAILED      = 'storage_file_deletion_failed';
    const STORAGE_FILE_NOT_READABLE         = 'storage_file_not_readable';
    const STORAGE_FILE_EMPTY                = 'storage_file_empty';
    const STORAGE_FILE_TYPE_UNSUPPORTED     = 'storage_file_type_unsupported';
    const STORAGE_INVALID_READ_PERMISSIONS  = 'storage_invalid_read_permissions';
    const STORAGE_INVALID_WRITE_PERMISSIONS = 'storage_invalid_write_permissions';
    const STORAGE_INVALID_FILE_SIZE         = 'storage_invalid_file_size';
    const STORAGE_INVALID_FILE              = 'storage_invalid_file';
    const STORAGE_FAILED_TO_MOVE_FILE       = 'storage_failed_to_move_file';
    const STORAGE_FAILED_TO_WRITE_FILE      = 'storage_failed_to_write_file';

    /** Functions */
    const FUNCTION_NOT_FOUND       = 'function_not_found';
    const FUNCTION_DELETION_FAILED = 'function_deletion_failed';

    /** Deployments */
    const DEPLOYMENT_NOT_FOUND       = 'deployment_not_found';
    const DEPLOYMENT_DELETION_FAILED = 'deployment_deletion_failed';

    /** Execution */
    const EXECUTION_NOT_FOUND       = 'execution_not_found';

    /** Projects */
    const PROJECT_NOT_FOUND       = 'project_not_found';
    const PROJECT_UNKNOWN         = 'project_unknown';

    /** API */
    const UNKNOWN                 = 'unknown';
    const UNKNOWN_ORIGIN          = 'unknown_origin';
    const SERVICE_DISABLED        = 'service_disabled';
    const UNAUTHORIZED_SCOPE      = 'unauthorized_scope';
    const STORAGE_ERROR           = 'storage_error';
    const RATE_LIMIT_EXCEEDED     = 'rate_limit_exceeded';
    const SMTP_DISABLED           = 'smtp_disabled';


    private $errorCode = '';

    public function __construct(string $message, int $code = 0, string $errorCode = Exception::UNKNOWN, \Throwable $previous = null)
    {
        $this->errorCode = $errorCode;

        parent::__construct($message, $code, $previous);
    }

    /**
     * @return string
     */ 
    public function getErrorCode(): string
    {
        return $this->errorCode;
    }
}