MediaWiki:Gadget-markreview.js

Note: After publishing, you may have to bypass your browser's cache to see the changes.

• Firefox / Safari: Hold Shift while clicking Reload, or press either Ctrl-F5 or Ctrl-R (⌘-R on a Mac)
• Google Chrome: Press Ctrl-Shift-R (⌘-Shift-R on a Mac)
• Edge: Hold Ctrl while clicking Refresh, or press Ctrl-F5.

/* Gadget: MarkReview — One‑click "Mark as reviewed" for page owners (updates DocMeta parameter) */
mw.loader.using(['mediawiki.api', 'mediawiki.util', 'mediawiki.user']).then(function () {

  function run($content) {
    var $docMeta = $content.find('.doc-meta').first();
    if (!$docMeta.length) {
      $docMeta = $('.doc-meta').first();
      if (!$docMeta.length) return;
    }

    var owner = $docMeta.attr('data-owner');
    var user = mw.config.get('wgUserName');
    var action = mw.config.get('wgAction') || 'view';
    if (action !== 'view') return;
    if (!owner || !user || owner.toLowerCase() !== user.toLowerCase()) return;

    function localStamp() {
      var now = new Date();
      return now.getFullYear() + '-' +
        String(now.getMonth() + 1).padStart(2, '0') + '-' +
        String(now.getDate()).padStart(2, '0') + 'T' +
        String(now.getHours()).padStart(2, '0') + ':' +
        String(now.getMinutes()).padStart(2, '0') + ':' +
        String(now.getSeconds()).padStart(2, '0');
    }

    function doReview() {
      var page = mw.config.get('wgPageName');
      var stamp = localStamp();
      var api = new mw.Api();

      api.get({
        action: 'query',
        prop: 'revisions',
        titles: page,
        rvslots: 'main',
        rvprop: 'content|timestamp',
        formatversion: 2
      }).done(function (data) {
        var pg = data.query.pages[0];
        if (!pg || !pg.revisions || !pg.revisions.length) {
          mw.notify('Could not read page content', { type: 'error' });
          return;
        }
        var rev = pg.revisions[0];
        var content = rev.slots.main.content;
        var baseTs = rev.timestamp;

        // Find the first {{DocMeta ...}} block (non-greedy to the first }}
        var docmetaRe = /\{\{\s*DocMeta\b([\s\S]*?)\}\}/i;
        var m = content.match(docmetaRe);
        if (!m) {
          mw.notify('DocMeta block not found on this page', { type: 'error' });
          return;
        }

        var block = m[0];
        var inner = m[1]; // content between 'DocMeta' and closing '}}'

        // Normalise newlines
        var nl = /\r\n/.test(block) ? '\r\n' : '\n';

        // Does review_ping already exist?
        var rpRe = /(\|\s*review_ping\s*=\s*)(.*)/i;
        var newInner;

        if (rpRe.test(inner)) {
          // Replace its value only on that line
          newInner = inner.replace(rpRe, function(_, prefix) {
            return prefix + stamp;
          });
        } else {
          // Insert a new line with review_ping before the closing }}
          // Preserve indentation if present
          var indentMatch = inner.match(/\n([ \t]*)\|/);
          var indent = indentMatch ? indentMatch[1] : ' ';
          newInner = inner.replace(/[\s\S]*$/, function (s) {
            // Ensure trailing newline inside the template block
            if (!/\n$/.test(s)) s += nl;
            return s + indent + '| review_ping = ' + stamp + nl;
          });
        }

        var newBlock = block.replace(inner, newInner);
        var newContent = content.replace(docmetaRe, newBlock);

        // Remove any old HTML comment pings (optional cleanup)
        newContent = newContent.replace(/<!--\s*review-ping:.*?-->\s*/gi, '');

        api.postWithToken('csrf', {
          action: 'edit',
          title: page,
          text: newContent,
          summary: 'Mark as reviewed',
          minor: true,
          nocreate: true,
          basetimestamp: baseTs, // basic edit-conflict protection
          starttimestamp: data.curtimestamp
        }).done(function () {
          location.reload();
        }).fail(function (err) {
          mw.notify('Review failed: ' + (err && err.error && err.error.info ? err.error.info : err), { type: 'error' });
        });
      }).fail(function (err) {
        mw.notify('Failed to fetch page: ' + err, { type: 'error' });
      });
    }

    // Create the button
    var $btn = $('<a>')
      .attr('href', '#')
      .text('Mark as reviewed')
      .css({
        display: 'inline-block',
        marginTop: '8px',
        padding: '4px 8px',
        background: '#f0f0f0',
        border: '1px solid #ccc',
        borderRadius: '2px',
        textDecoration: 'none'
      })
      .on('click', function (e) {
        e.preventDefault();
        doReview();
      });

    // Place it under the DocMeta table
    var $actions = $docMeta.closest('table').nextAll('.doc-meta-actions').first();
    if (!$actions.length) {
      $actions = $('<div class="doc-meta-actions"></div>').insertAfter($docMeta.closest('table'));
    }
    $actions.empty().append($btn);
  }

  mw.hook('wikipage.content').add(run);
});