dl_free_fr.sh
# Plowshare dl.free.fr module
# Copyright (c) 2010-2016 Plowshare team
#
# This file is part of Plowshare.
#
# Plowshare 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 3 of the License, or
# (at your option) any later version.
#
# Plowshare 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 Plowshare.  If not, see <http://www.gnu.org/licenses/>.

MODULE_DL_FREE_FR_REGEXP_URL='http://dl\.free\.fr/'

MODULE_DL_FREE_FR_DOWNLOAD_OPTIONS="
LINK_PASSWORD,p,link-password,S=PASSWORD,Used in password-protected files"
MODULE_DL_FREE_FR_DOWNLOAD_RESUME=yes
MODULE_DL_FREE_FR_DOWNLOAD_FINAL_LINK_NEEDS_COOKIE=yes
MODULE_DL_FREE_FR_DOWNLOAD_FINAL_LINK_NEEDS_EXTRA=()
MODULE_DL_FREE_FR_DOWNLOAD_SUCCESSIVE_INTERVAL=

MODULE_DL_FREE_FR_UPLOAD_OPTIONS="
LINK_PASSWORD,p,link-password,S=PASSWORD,Protect a link with a password
TOEMAIL,,email-to,e=EMAIL,<To> field for uploader email (TO field)
CCEMAIL,,email-cc,e=EMAIL,<Cc> field for notification email (CC field)
MESSAGE,,message,S=MESSAGE,Set email description (sent with notification email)"
MODULE_DL_FREE_FR_UPLOAD_REMOTE_SUPPORT=no

MODULE_DL_FREE_FR_DELETE_OPTIONS=""

MODULE_DL_FREE_FR_PROBE_OPTIONS=""

# Output a dl.free.fr file download URL (anonymous)
# $1: cookie file
# $2: dl.free.fr url
# stdout: real file download link
dl_free_fr_download() {
    local -r COOKIE_FILE=$1
    local URL=$2
    local PAGE FORM_HTML FORM_ACTION FORM_FILE SESSID FILE_NAME

    # Notes:
    # - "curl -I" (HTTP HEAD request) is ignored (returns 404 error)
    # - Range request is ignored for non Free ISP users (due to redir?)
    PAGE=$(curl -L -i -r 0-1023 "$URL") || return

    # Bad link
    if match '^HTTP/1.1 404' "$PAGE"; then
        return $ERR_LINK_DEAD
    fi

    # Free is your ISP, this is direct download
    if match '^HTTP/1.1 206' "$PAGE"; then

        # <li>5 slots max / IP / machine</li>
        if match '^Location:.*overload\.html' "$PAGE"; then
            echo 600
            return $ERR_LINK_TEMP_UNAVAILABLE
        fi

        MODULE_DL_FREE_FR_DOWNLOAD_FINAL_LINK_NEEDS_COOKIE=no
        MODULE_DL_FREE_FR_DOWNLOAD_FINAL_LINK_NEEDS_EXTRA=(--retry 2)

        FILE_NAME=$(grep_http_header_content_disposition <<< "$PAGE") || return

        echo "$URL"
        echo "$FILE_NAME"
        return 0
    fi

    match 'Fichier inexistant\.' "$PAGE" && return $ERR_LINK_DEAD

    local -r ERR1='erreur 500 - erreur interne du serveur'
    local -r ERR2='erreur 404 - document non trouv.'
    if matchi "$ERR1\|$ERR2" "$PAGE"; then
        return $ERR_LINK_DEAD
    fi

    FILE_NAME=$(parse '>Fichier<' '>\([^<>]*\) <br' <<< "$PAGE") || return

    FORM_HTML=$(grep_form_by_order "$PAGE" 1) || return
    FORM_ACTION=$(parse_form_action <<< "$FORM_HTML") || return
    FORM_FILE=$(parse_form_input_by_name 'file' <<< "$FORM_HTML" | uri_encode_strict) || return

    # Here we set a cookie file for a final link.
    # Notes: "curl -I" (HTTP HEAD request) is ignored.
    PAGE=$(curl -L -i -r 0-1023 -c "$COOKIE_FILE" \
        -d "file=$FORM_FILE" \
        --referer "$URL" \
        "http://dl.free.fr/$FORM_ACTION") || return

    # WWW-Authenticate: Basic realm="Autorisation requise"
    if match '^HTTP/1.1 401' "$PAGE"; then
        log_debug 'File is password protected.'

        if [ -z "$LINK_PASSWORD" ]; then
            LINK_PASSWORD=$(prompt_for_password) || return
        fi

        # Notes: "curl -I" (HTTP HEAD request) is ignored (returns 404 error)
        PAGE=$(curl -L -i -r 0-1023 -b "$COOKIE_FILE" \
            --user ":$LINK_PASSWORD" \
            "$URL") || return

        if match '^HTTP/1.1 401' "$PAGE"; then
            log_error 'Wrong password'
            return $ERR_LINK_PASSWORD_REQUIRED
        fi

        MODULE_DL_FREE_FR_DOWNLOAD_FINAL_LINK_NEEDS_EXTRA=(--user ":$LINK_PASSWORD")
    fi

    echo "$URL"
    echo "$FILE_NAME"
}

# Upload a file to dl.free.fr
# $1: cookie file (unused here)
# $2: input file (with full path)
# $3: remote filename
# stdout: dl.free.fr download + del link
dl_free_fr_upload() {
    local FILE=$2
    local DESTFILE=$3
    local UPLOADURL='http://dl.free.fr'
    local PAGE FORM_HTML FORM_ACTION HEADERS MON_PL WAIT_TIME DL_URL DEL_URL

    PAGE=$(curl "$UPLOADURL") || return

    FORM_HTML=$(grep_form_by_order "$PAGE" 2) || return
    FORM_ACTION=$(parse_form_action <<< "$FORM_HTML") || return

    # <input> markers are: ufile, mail1, mail2, mail3, mail4, message, password
    # Returns 302. Answer headers are not returned with -i switch, I must
    # use -D. This should be reported to cURL bug tracker.
    HEADERS=$(create_tempfile) || return
    PAGE=$(curl_with_log -D "$HEADERS" \
        --referer "$UPLOADURL/index_nojs.pl" \
        -F "ufile=@$FILE;filename=$DESTFILE" \
        -F "mail1=$TOEMAIL" \
        -F "mail2=$CCEMAIL" \
        -F "mail3=" \
        -F "mail4=" \
        -F "message=$MESSAGE" \
        -F "password=$LINK_PASSWORD" \
        "$UPLOADURL$FORM_ACTION") || return

    MON_PL=$(cat "$HEADERS" | grep_http_header_location) || return
    rm -f "$HEADERS"

    log_debug "Monitoring page: $MON_PL"

    # http://dl.free.fr/fo.html
    if ! match '=' "$MON_PL"; then
        log_debug 'Monitoring page seems wrong, abort'
        return $ERR_FATAL
    fi

    WAIT_TIME=5
    while [ $WAIT_TIME -lt 320 ] ; do
        PAGE=$(curl "$MON_PL") || return

        if match 'En attente de traitement...' "$PAGE"; then
            log_debug 'please wait'
            ((WAIT_TIME += 4))
        elif match 'Test antivirus...' "$PAGE"; then
            log_debug 'antivirus test'
            WAIT_TIME=3
        elif match 'Mise en ligne du fichier...' "$PAGE"; then
            log_debug 'nearly online!'
            WAIT_TIME=2
        elif match 'Erreur de traitement...' "$PAGE"; then
            log_error 'process failed, you may try again'
            break
        # Fichier "foo" en ligne, procédure terminée avec succès...
        elif match 'Le fichier sera accessible' "$PAGE"; then
            DL_URL=$(parse 'en ligne' "window\.open('\(http://dl.free.fr/[^?]*\)')" \
                <<< "$PAGE" | html_to_utf8) || return
            DEL_URL=$(parse 'en ligne' "window\.open('\(http://dl.free.fr/rm\.pl[^']*\)" \
                <<< "$PAGE" | html_to_utf8) || return

            echo "$DL_URL"
            echo "$DEL_URL"
            return 0
        else
            log_error 'unknown state, abort'
            break
        fi

        wait $WAIT_TIME seconds
    done
    return $ERR_FATAL
}

# Delete a file from dl.free.fr
# $1: cookie file (unused here)
# $2: dl.free.fr (delete) link
dl_free_fr_delete() {
    local URL=$2
    local -r BASE_URL='http://dl.free.fr'
    local PAGE

    PAGE=$(curl "$URL") || return

    # Fichier perimé ou déjà supprimé
    match 'Fichier perim&eacute ou d&eacute;j&agrave; supprim&eacute;' \
        "$PAGE" && return $ERR_LINK_DEAD

    # Si vous souhaitez réelement supprimer le fichier nommé [<FILE_NAME>] cliquez ici
    if match 'Si vous souhaitez r&eacute;element supprimer' "$PAGE"; then
        URL=$(parse_attr 'Si vous souhaitez' 'href' <<< "$PAGE") || return
        PAGE=$(curl "$BASE_URL$URL") || return

        # Le fichier nommé [<FILE_NAME>] a été supprimé avec succès.
        match 'supprim&eacute; avec succ&egrave;s' "$PAGE" && return 0
    fi

    log_error 'Unexpected content. Site updated?'
    return $ERR_FATAL
}

# Probe a download URL
# $1: cookie file (unused here)
# $2: dl.free.fr url
# $3: requested capability list
# stdout: 1 capability per line
dl_free_fr_probe() {
    local -r URL=$2
    local -r REQ_IN=$3
    local PAGE FILE_NAME FILE_SIZE REQ_OUT

    PAGE=$(curl -L -i -r 0-1023 "$URL") || return

    if match '^HTTP/1.1 401' "$PAGE"; then
        return $ERR_LINK_NEED_PERMISSIONS
    fi

    REQ_OUT=c

    # Free is your ISP, this is direct download
    if match '^HTTP/1.1 206' "$PAGE"; then
        if [[ $REQ_IN = *f* ]]; then
            FILE_NAME=$(grep_http_header_content_disposition <<< "$PAGE") &&
                echo "$FILE_NAME" && REQ_OUT="${REQ_OUT}f"
        fi
        if [[ $REQ_IN = *s* ]]; then
            FILE_SIZE=$(parse '^Content-Range:' '/\([[:digit:]]*\)' <<< "$PAGE") && \
                echo "$FILE_SIZE" && REQ_OUT="${REQ_OUT}s"
        fi

    else
        match 'Fichier inexistant\.' "$PAGE" && return $ERR_LINK_DEAD
        matchi 'erreur[[:space:]][45]' "$PAGE" && return $ERR_LINK_DEAD

        if [[ $REQ_IN = *f* ]]; then
            FILE_NAME=$(parse '>Fichier<' '>\([^<>]*\) <br' <<< "$PAGE") &&
                echo "$FILE_NAME" && REQ_OUT="${REQ_OUT}f"
        fi
        if [[ $REQ_IN = *s* ]]; then
            FILE_SIZE=$(parse '>Taille<' '>\([^<>]*\) <br' <<< "$PAGE") &&
                translate_size "${FILE_SIZE/o/B}" && REQ_OUT="${REQ_OUT}s"
        fi
    fi

    echo $REQ_OUT
}
