Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/joshp23/YOURLS-title-refetch
A simple plugin to refetch poorly defined titles in YOURLS
https://github.com/joshp23/YOURLS-title-refetch
yourls yourls-title-refetch
Last synced: 14 days ago
JSON representation
A simple plugin to refetch poorly defined titles in YOURLS
- Host: GitHub
- URL: https://github.com/joshp23/YOURLS-title-refetch
- Owner: joshp23
- License: gpl-3.0
- Created: 2017-06-23T07:04:13.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2021-03-14T06:20:45.000Z (over 3 years ago)
- Last Synced: 2024-08-02T06:17:35.620Z (4 months ago)
- Topics: yourls, yourls-title-refetch
- Language: PHP
- Size: 31.3 KB
- Stars: 4
- Watchers: 4
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - Title Refetch - Refetch page titles. (Plugins / T)
README
# YOURLS-title-refetch
A simple plugin to refetch poorly defined titles in YOURLS
### The Problem
Sometimes YOURLS does not fetch the title of a url that is being processed, this happens frequently when using the api with certain 3rd party applications (which need attention from their developers). When this occures YOURLS uses the url itself as the title in the databse, which is less than desireable.
Also, sometimes a website will update the title of an article or post. When displaying a [preview page](https://github.com/joshp23/YOURLS-Snapshot) it would be desireable to have the most up-to-date titles of pages on display.
### The solution
This plugin adds a new `key->value` pair to `action=shorturl`, and if it is present will check the title of the new link and attempt to repair it if it is malformed.
### Installation
Extract the `title-refetch` folder in this repo into the `YOURLS/user/plugins/` directory and enable it in the admin interface.
### Usage
1. Send the `refetch=true` along with a typical API shorturl call. Ex:
```
https://eg.com/yourls-api.php?refetch=true&action=shorturl&url=https://some.really.long.url.com/it_never/ends/index.php
```
2. This plugin also creates a new api action:
- `action=refetch` which will trigger a refetch check according to one of the following required conditions:
- `target=title` which will check a single link and requires`shorturl=EX`. The short url can be a keyword or a full short url.
- `target=title-force` skips the malformed url check and just looks for an updated title. Requires `shorturl=EX`.
- `target=all` which will run a check on the entire database and requires a valid log in (eg. signature or user/pass)
3. There is an action button in the admin section to force-update single links at a a time.
Note: This button is filtered by [AuthMgrPlus](https://github.com/joshp23/YOURLS-AuthMgrPlus) with the `EditURL` capability, if installed.
#### The catch
While this doesn't cause the developers of third party applications to give attetnion to their code, it does make integration more flexible and provides an immediate working solution on YOURLS's end, akin to the [api-concurrence-fix](https://bitbucket.org/laceous/yourls-concurrency-fix) plugin.
#### Note:
This module was initially developed to assist with integration of the [Drupal: Shorten URLs](https://www.drupal.org/project/shorten) module. An issue regarding this can be found [here](https://www.drupal.org/node/2889342).
### Tips
Dogecoin: DARhgg9q3HAWYZuN95DKnFonADrSWUimy3