maxurl README

The project's README from github.com/qsniyg/maxurl. As one markdown file: README.md.

Image Max URL

English | Português (Brasil)

Image Max URL is a program that will try to find larger/original versions of images and videos, usually by replacing URL patterns.

It currently contains support for >10,000 hardcoded websites (full list in sites.txt), but it also supports a number of generic engines (such as Wordpress and MediaWiki), which means it can work for many other websites as well.

It is currently released as:

Community:

Sideloading the extension

The extension is currently unavailable to other browsers' addon stores (such as Chrome and Microsoft Edge), but you can sideload this repository if you wish to use the extension version instead of the userscript.

Tor Browser/Mullvad Browser

In order to use the extension on Tor Browser, ensure that the "Run in Private Windows" option is enabled in the about:addons page.

Due to various anti-fingerprinting measures, many of the default shortcuts (such as any that include Alt) will not work. You'll need to rebind these. Some users prefer rebinding Shift+Alt+I to Ctrl+`.

Contributing

Any contribution is greatly appreciated! If you have any bug reports, feature requests, or new websites you want supported, please file an issue here.

If you don't have a Github account, feel free to either use one of the community links above or contact me directly.

If you wish to contribute to the repository itself (code contributions, translations, etc.), please check CONTRIBUTING.md for more information.

Integrating IMU in your program

As mentioned above, userscript.user.js also functions as a node module.

var maximage = require('./userscript.user.js');

maximage(smallimage, {
  // If set to false, it will return only the URL if there aren't any special properties
  // Recommended to keep true.
  //
  // The only reason this option exists is as a small hack for a helper userscript used to find new rules,
  //  to check if IMU already supports a rule.
  fill_object: true,

  // Maximum amount of times it should be run.
  // Recommended to be at least 5.
  iterations: 200,

  // Whether or not to store to, and use an internal cache for URLs.
  // Set this to "read" if you want to use the cache without storing results to it.
  use_cache: true,

  // Timeout (in seconds) for cache entries in the URL cache
  urlcache_time: 60*60,

  // List of "problems" (such as watermarks or possibly broken image) to exclude.
  //
  // By default, all problems are excluded.
  // You can access the excluded problems through maximage.default_options.exclude_problems
  // By setting it to [], no problems will be excluded.
  //exclude_problems: [],

  // Whether or not to exclude videos
  exclude_videos: false,

  // This will include a "history" of objects found through iterations.
  // Disabling this will only keep the objects found through the last successful iteration.
  include_pastobjs: true,

  // This will try to find the original page for an image, even if it requires extra requests.
  force_page: false,

  // This allows rules that use 3rd-party websites to find larger images
  allow_thirdparty: false,

  // This is useful for implementing a blacklist or whitelist.
  //  If unspecified, it accepts all URLs.
  filter: function(url) {
    return true;
  },

  // Helper function to perform HTTP requests, used for sites like Flickr
  //  The API is expected to be like GM_xmlHTTPRequest's API.
  // An implementation using node's request module can be found in reddit-bot/dourl.js
  do_request: function(options) {
    // options = {
    //   url: "",
    //   method: "GET",
    //   data: "", // for method: "POST"
    //   overrideMimeType: "", // used to decode alternate charsets
    //   headers: {}, // If a header is null or "", don't include that header
    //   onload: function(resp) {
    //     // resp is expected to be XMLHttpRequest-like object, implementing these fields:
    //     //   finalUrl
    //     //   readyState
    //     //   responseText
    //     //   status
    //   }
    // }
  },

  // Callback
  cb: function(result) {
    if (!result)
      return;

    if (result.length === 1 && result[0].url === smallimage) {
       // No larger image was found
       return;
    }

    for (var i = 0; i < result.length; i++) {
      // Do something with the object
    }
  }
});

The result is a list of objects that contain properties that may be useful in using the returned image(s):

[{
  // The URL of the image
  url: null,

  // Whether or not this URL is a video
  video: false,

  // Whether it's expected that it will always work or not.
  //  Don't rely on this value if you don't have to
  always_ok: false,

  // Whether or not the URL is likely to work.
  likely_broken: false,

  // Whether or not the server supports a HEAD request.
  can_head: true,

  // HEAD errors that can be ignored
  head_ok_errors: [],

  // Whether or not the server might return the wrong Content-Type header in the HEAD request
  head_wrong_contenttype: false,

  // Whether or not the server might return the wrong Content-Length header in the HEAD request
  head_wrong_contentlength: false,

  // This is used in the return value of the exported function.
  //  If you're using a callback (as shown in the code example above),
  //  this value will always be false
  waiting: false,

  // Whether or not the returned URL is expected to redirect to another URL
  redirects: false,

  // Whether or not the URL is temporary/only works on the current IP (such as a generated download link)
  is_private: false,

  // Whether or not the URL is expected to be the original image stored on the website's servers.
  is_original: false,

  // If this is true, you shouldn't input this URL again into IMU.
  norecurse: false,

  // Whether or not this URL should be used.
  // If true, treat this like a 404
  // If "mask", this image is an overlayed mask
  bad: false,

  // Same as above, but contains a list of objects, e.g.:
  // [{
  //    headers: {"Content-Length": "1000"},
  //    status: 301
  // }]
  // If one of the objects matches the response, it's a bad image.
  // You can use maximage.check_bad_if(bad_if, resp) to check.
  //  (resp is expected to be an XHR-like object)
  bad_if: [],

  // Whether or not this URL is a "fake" URL that was used internally (i.e. if true, don't use this)
  fake: false,

  // Headers required to view the returned URL
  //  If a header is null, don't include that header.
  headers: {},

  // Additional properties that could be useful
  extra: {
    // The original page where this image was hosted
    page: null,

    // The title/caption attached to the image
    caption: null
  },

  // If set, this is a more descriptive filename for the image
  filename: "",

  // A list of problems with this image. Use exclude_problems to exclude images with specific problems
  problems: {
    // If true, the image is likely larger than the one inputted, but it also has a watermark (when the inputted one doesn't)
    watermark: false,

    // If true, the image is likely smaller than the one inputted, but it has no watermark
    smaller: false,

    // If true, the image might be entirely different from the one inputted
    possibly_different: false,

    // If true, the image might be broken (such as GIFs on Tumblr)
    possibly_broken: false
  }
}]

maxurl (qsniyg/maxurl)

Searching Database…

1.6K ·GitHub
Maxurl
What is this?Image Max URL (maxurl) is a tool that finds larger or original versions of images and videos, usually by rewriting their URLs. It has built-in support for over 10,000 specific sites plus generic engines like WordPress and MediaWiki.
Is this a browser extension or a userscript?It's released in several forms built from the same core: a userscript (the recommended way to run it), a Firefox browser extension, a Node module, an embeddable website, and a Reddit bot.
Do I need anything else installed to run it?To use the userscript version you need a userscript manager; the extension and sideloading routes don't need any extra software beyond the browser itself.
Can I just get the extension from the Chrome Web Store?No - the extension isn't published on Chrome's or Edge's add-on stores, so on those browsers you have to sideload it manually (load unpacked, or drag in a built CRX file).
Does the website version work the same as the extension?No - the standalone website can't support every URL because some require cross-origin requests that browser security blocks, something the extension and userscript aren't limited by.
Does it work in Tor Browser?Yes, but you need to enable the 'Run in Private Windows' option, and you'll likely have to rebind some keyboard shortcuts (like Alt-based ones) since Tor's anti-fingerprinting measures break the defaults.
Can I use maxurl in my own script instead of a browser?Yes, userscript.user.js also works as a Node module - it's the same module that powers the project's Reddit bot.
What does the Reddit bot do?u/MaxImageBot replies in Reddit comments with links to larger or original versions of images, using the same core engine as the userscript (source in reddit-bot/comment-bot.js and dourl.js).
What if a site I use isn't supported yet?You can file an issue requesting support for a new site, or contribute code yourself (see CONTRIBUTING.md) - support is pattern-based so many unlisted sites may still work through the generic engines.
What are similar projects?Telegram-Media-Downloader, streamfirefly, cat-catch, return-youtube-dislike, desktop_gifs, TwitchAdSolutions, video_vip, gemini-watermark-remover
Which topics is it in?webextension, reddit, gallery, userscript, video-downloader, download, website, firefox, firefox-extension, image, downloader, chrome-extension
Creator
qsniyg
Size
769.5 MB
Stars
1.6K
Updated
CommitOct 05
Age
8y
Commits · 90 Days