Feature request: upload.

[hugolpz]

Hello, You already got quite some useful, practical codes on the README.md, from wikipedias to wikidata, from GET to Replace.

Since the developments is active, I would suggest you the following new axe :

• Upload: :mw:API:Upload

NodeJS syntaxe from :mw:API:Upload

// Step 4: POST request to upload a file directly
function upload(csrf_token) {
    var params_3 = {
        action: "upload",
        filename: "Sandboxfile1.jpg",                  // `data[i].filename` comes here
        ignorewarnings: "1",
        comment: "comment here",                    // `data[i].comment` comes here
        token: csrf_token,
        format: "json"
    };

    var file = {
        file: fs.createReadStream('My.jpg')         // `data[i].filepath` comes here
    };

    var formData = Object.assign( {}, params_3, file );

    request.post({ 
        url: url,               // API's root url such as "https://test.wikipedia.org/w/api.php";
        formData: formData 
    }, function (error, res, body) {
        body = JSON.parse(body);
        if (error) { return; }
        else if (body.upload.result === "Success"){
            console.log("File Uploaded :)");
        }
    });
}

Input parameters

• filepath: path to file to upload.
  • type: string
  • default: "birds.png"
• filename: target filename as wished on Wikimedia Commons.
  • type: string
  • default: "wikiapiTestUploadOnCommons.png"
• comment: Upload comment. Also used as the initial page text for new files if text is not specified.
  • type: string
  • default: "Upload successful !"+ new Date().toISOString().slice(0,-5)

Under consideration:

• directory: path to directory with image(s). (Dev node: maybe just push it into data[i].filename ?)
  • type: string. Ex: ~/Documents/ImagesLouvres/
  • default: ./

Some default parameters

• tags: Change tags to apply to the upload log entry and file page revision.
  • type: Values (separate with | or alternative): possible vandalism, repeating characters
• ignorewarnings: Ignore any warnings
  • type: boolean

Url or filepath

The difference between upload of local file or online file is minor and can be balanced via a conditional.

Example 1: Upload a local file directly

Example 2: Upload file from URL

~~~ javascript // Step 4: POST request to upload a file directly function upload(csrf_token) { var params_3 = { action: "upload", filename: "Sandboxfile1.jpg", ignorewarnings: "1", token: csrf_token, format: "json" }; var file = { file: fs.createReadStream('My.jpg') }; var formData = Object.assign({}, params_3, file); request.post({ url: url, // API https://en.wikipedia.org/w/api.php formData: formData }, function(error, res, body) { body = JSON.parse(body); if (error) { return; } else if (body.upload.result === "Success") { console.log("File Uploaded :)"); } }); } ~~~

~~~ javascript // Step 4: POST request to upload a file from a URL function editRequest(csrf_token) { var params_3 = { action: "upload", filename: "Test-ABCD.jpg", url: "https://farm9.staticflickr.com/8213/8300206113_374c017fc5.jpg", ignorewarnings: "1", token: csrf_token, format: "json" }; request.post({ url: url, // API https://en.wikipedia.org/w/api.php form: params_3 }, function(error, res, body) { body = JSON.parse(body); if (error) { return; } else if (body.upload.result === "Success") { console.log("File Uploaded :)"); } }); } ~~~

So a conditional and some minor fixes should be enough

• url: URL to fetch the file from.
  • conditional:

    if( filepath.indexOf("http") == 0 ) {
    params_3.url = filepath
    } else {
    params_3.file = fs.createReadStream(filepath)
    }

    Note: form and formData are lightly different. (I'am not sure it affects our case).

Attached file

• birds.png : open in browser, save me as birds.png within your git repository, git add me. Adapt code so by default, it load and upload me to Wikimedia Commons.

[hugolpz]

@kanasimi, thank for the quick integration. I'am trying to learn from your commits. :+1: