Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/takuy/yourls-replacetext

This plugin for YOURLS allows you to create redirects based on regex patterns, simple text replacements or script.
https://github.com/takuy/yourls-replacetext

yourls yourls-plugin

Last synced: 7 days ago
JSON representation

This plugin for YOURLS allows you to create redirects based on regex patterns, simple text replacements or script.

Host: GitHub
URL: https://github.com/takuy/yourls-replacetext
Owner: takuy
License: mit
Created: 2024-03-01T03:51:33.000Z (4 months ago)
Default Branch: master
Last Pushed: 2024-03-07T03:00:10.000Z (4 months ago)
Last Synced: 2024-03-08T03:45:16.821Z (4 months ago)
Topics: yourls, yourls-plugin
Language: PHP
Homepage:
Size: 17.6 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE.txt

Lists

awesome - Replace Text - Replace URL or tokens in URL based on keyword, regex pattern matching, or script. (Plugins / R)

README

        # Plugin for YOURLS: replacetext

## What for

This plugin allows you to create dynamic or smart redirects - not 100% sure what to call them, but you can use regex, simple text replacements or a script!

## How to install

* In `/user/plugins`, create a new folder named `replacetext`

* Drop these files in that directory

* Go to the Plugins administration page and activate the plugin 

* Have fun

## How to use

A short URL keyword prefixed with `regex/`, followed by a regex pattern will allow you to redirect based on regex pattern, but also do replacements within the Long URL based on the pattern match. You can use numerical tokens like `[[1]]`, `[[2]]`, etc to insert specific match groups from the regex pattern. Prefix the number in the token with ! to force uppercase the replaced text, ie `[[!1]]`.

A short URL keyword in the format `wordone/wordtwo` will allow you to replace the token `[[wordone]]` in the long URL whatever ``wordtwo`` is in your Navigation URL.  

A replacement token may also be provided in a long URL, in which case a short URL navigation with that token as a query parameter will cause a replacement, ie, if a `[[token]]` is provided in a Long URL like `https://example.com/?lookup=[[token]]` with Short URL `https://sho.rt/ex` - then navigating to URL `https://sho.rt/ex?token=12345` will redirect you to `https://example.com/?lookup=12345`.

A short URL keyword in the format `$scriptname/` following by a regex pattern will allow you to call a script with name "`scriptname.php`" from the folder `./scripts/`. See [sample.php](scripts/sample.php) as an example for how the YOURLS filter hook should be structured. The requested keyword from the navigation URL, the matched Short URL keyword, the matched Long URL, and an array of the Regex matches are passed to the script. 

Most easily described with examples...

Base YOURLS example: `https://sho.rt` 

| Short URL | Long URL  | Navigation URL 
 _{what you would navigate to in your browser}  | Final Redirect    |

| ---       | ---           | ---               | ---               |

| `regex/(REQ[0-9]*)`| `https://example.com/?ticket=%22[[1]]%22` | `https://sho.rt/REQ0000010` | `https://example.com/?ticket="REQ0000010"` |

| `whatever`| `https://example.com/?ticket=%22[[req]]%22` | `https://sho.rt/whatever?req=REQ0000010` | `https://example.com/?ticket="REQ0000010"` |

| `regex/(.*)_(.*)` | `https://www.google.com/search?q=[[1]]&tbm=[[2]]` | `https://sho.rt/sample_isch` | `https://www.google.com/search?q=sample&tbm=isch` |

| `req` | `https://example.com/?ticket=%22[[req]]%22` | `https://sho.rt/req/REQ0000010` | `https://example.com/?ticket="REQ0000010"` | 

| `$sample/google_(.*)` | `anything` 
 _{passed to the script for use} | `https://sho.rt/google_hello%20world` | `https://www.google.com/search?q=hello%20world` |