Jump to content

URL Shortener


netcarver
 Share

Recommended Posts

Thanks to Ryan, I've managed to knock my next module into usable shape.

The URL Shortener adds a link shortening feature to ProcessWire, so you can host your own short URL service from a PW site now.

You can create as many bins for short links as you need & the module sets up an example bin when you install it. Each bin is a PW page that uses the LinkShortenerHome template. This template allows you to set the length of the shortened links that will reside in it. Shortened links are simply child pages that automatically use the LinkShortener template. As these links are normal PW pages you can manipulate them from the admin page tree just like any other page.

Anytime you create a new short-link page in any of your bins, it will automatically be named with a random string that is not already in use in that bin. You get the chance to review this short string before adding the full URL and saving the page. Once the page is saved any visit to the short link's URL will be redirected to the full URL.

  • Like 9
Link to comment
Share on other sites

Just for inspiration: My version of an URL-Shortener (kind of older code previously featured on my blog):


require_once('database.class.php');
$db = new database('localhost', '', '', '');
$pass = '123';
$base_url = 'http://go.nico.is/';

function is_url($url) {
if(!preg_match("#^http(s)?://[a-z0-9-_.]+\.[a-z]{2,4}#i", $url)) {
return false;
} else {
return true;
}
}

function url_encrypt($id) {
$codeset = "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ";
$base = strlen($codeset);
$converted = "";

while ($id > 0) {
$converted = substr($codeset, ($id % $base), 1) . $converted;
$id = floor($id/$base);
}

return $converted;
}

function url_decrypt($converted) {
$codeset = "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ";
$base = strlen($codeset);
$c = 0;

for ($i = strlen($converted); $i; $i--) {
$c += strpos($codeset, substr($converted, (-1 * ( $i - strlen($converted) )),1))
* pow($base,$i-1);
}

return $c;
}

if($_GET['do'] != '' && isset($_GET['url']) && $_GET['pass'] == $pass) {
$url = rawurldecode($_GET['url']);

if($_GET['do'] == 'remove') {
if($db->delete('urls', '`url`=\''.$url.'\'')) {
$note = 'true';
} else {
$note = 'false';
}
} elseif($_GET['do'] == 'stats') {
$note = (($db->get_element('urls', 'stats', '`url`=\''.$url.'\'')) ? $db->get_element('urls', 'stats', '`url`=\''.$url.'\'') : '0');
} elseif($_GET['do'] == 'add') {
if(!$db->get_element('urls', 'converted', '`url`=\''.$url.'\'')) {
$id = $db->get_next_id('urls');

if($db->insert('urls', array('id' => $id, 'url' => $url, 'converted' => $converted, 'stats' => 0))) {
$note = $base_url.url_encrypt($id);
} else {
$note = 'false';
}
} else {
$note = $base_url.$db->get_element('urls', 'converted', '`url`=\''.$url.'\'');
}
}
} elseif(isset($_GET['converted'])) {
$id = url_decrypt($_GET['converted']);
$url = $db->get_element('urls', 'url', '`id`=\''.$id.'\'');
$db->update('urls', array('stats' => ((int)$db->get_element('urls', 'stats', '`id`=\''.$id.'\'') + 1)), '`id`=\''.$id.'\'');

header('HTTP/1.1 301 Moved Permanently');
header('Location: '.$url);
exit;
}

if($note != '') {
echo $note;
}
  • Like 1
Link to comment
Share on other sites

@Ryan,

Is there any way to prevent PW from using all lowercase characters in a page's path? For this module, allowing uppercase characters in the shortened URL would really increase the bin sizes -- or allow shorter links for a given bin capacity. Currently I use a 31 character alphabet for generating the short links giving a maximum of 887,503,681 links using 6 characters. If I could add 19 visually distinct uppercase characters to the alphabet this would increase to 15,625,000,000.

Link to comment
Share on other sites

I think it might be a fairly major change to the PW core to make it work with uppercase characters in URLs built on page names (though not 100% certain). But I think there are a lot of good reasons to normalize the case for URLs, so it's a change that might not be ideal for the larger system. Obviously those reasons don't apply to a URL shortener, and I can totally see the benefits for the URL shortener. The best way may be to have some kind of translation system in place where an underscore preceding a page name means the following character is uppercase, or something like that. Then your module's __construct() method could modify the value of $_GET['it'] before PW gets to it, i.e.

if(strpos($_GET['it'], '/r/') === 0) {

// if URL matches the format you are looking for

// replace uppercase character with the lowercase version preceded by an underscore

$_GET['it'] = strtolower(preg_replace('/([A-Z])/', '_$1', $_GET['it']));

}

Btw, that $_GET['it'] is set by your htaccess file and it's where ProcessWire looks for the URL from Apache's RewriteEngine. It's nothing more than the currently requested URL.

Another thing I want to mention is that there is no lowercase restriction with URL segments. So if you had your LinkShortenerHome.php template allowing URL segments, you could do something like this:

if($input->urlSegment1) {
 $name = strtolower(preg_replace('/([A-Z])/', '_$1', $input->urlSegment1);
 $p = $page->child("name=$name"); 
 if($p->id) $session->redirect($p->full_link); 
   else throw new Wire404Exception();
}

Also using URL segments, Another alternative is that you could just use your own custom text field to hold the short link (using upper and lower), and just let the page name take on the page's ID or something that wouldn't crossover with your short link names.

Another idea, but maybe for a future version. :) If you wanted to handle short links right from your homepage rather than /r/ (which would further shorten the URL), you could hook in before Page::render when the $page->id is 1 and have your module check if there is an $input->urlSegment1 present.

  • Like 1
Link to comment
Share on other sites

Thanks for the reply Ryan, lots of good ideas in there. I agree that there is no real benefit for the request other than for my module so absolutely no need to worry about core mods.

I did consider using URL segments for this module in the beginning but assumed, in ignorance, that enabling URL segments on the bin template would preclude me having the links as child pages and, as I definitely wanted to have the links as child pages, I chose not to explore that route. It's also good to know that URL segments can have uppercase characters. I'll probably look at moving over to a URL segment based solution for version 2 of this module. For now I've moved on to another module project. :)

Link to comment
Share on other sites

Hi Marty,

I must admit I hadn't considered using the URL shortener for links to the same site so that's an interesting use-case for me. I've just tried this locally and it's not as simple as just changing the type of the full_link field as you then need to go on and setup some of its more advanced options and tell it where in the page tree it can reference pages etc. I will think about this some more and get back to you.

Link to comment
Share on other sites

@steve - Cheers - no rush at all. Kind of a side point: I have a YOURLS setup on a short domain that I use through my twitter account which gives me short links like: http://stlmv.in/4l. I'm not a fan of 3rd party url shorteners because there's no guarantee they'll bee around in the future. YOURLS just works. Perhaps I'll sponsor a module that can automatically create a shortened URL from your YOURLS install. The API is here if anyone is interested: http://yourls.org/#API. And other side point is that some of my web clients actually print newsletters (crazy, I know) and reference urls in them. Having shorter urls makes that easier.

@antti: Oh yeah. I never thought to use it like that! :)

Regards

Marty

  • Like 2
Link to comment
Share on other sites

Once installed, you'll see a new "Short Links" page under your site root. This is a bin for storing shortlinks - which are simply child pages.
 

post-465-0-86735300-1462360106_thumb.png

If you edit the "Short Links" page you'll see various parameters that control the automatic generation of link names. You should be able to leave these as-is with no problems (unless you need more than 27,000,000,000+ links in your bin!) The parameters, if curious, are...

post-465-0-08976200-1462360108_thumb.png

You can add as many bins for shortlinks as you like to your site, just create a new page using the template "LinkShortenerHome" and give it a relatively short page name.

Anyway, let's add a short link now. From the page tree just click new next to the "Short Links" page. This creates a new shortlink page (uses the "LinkShortener" template) and automatically creates an unused, random, page name using the parameters we just looked at from the parent bin. Something like this...

post-465-0-94833100-1462360105_thumb.png

If you are not happy with the spelling of the generated shortlink (if it happens to be offensive in your native language for example) then you can change it now and hit the save button which takes us to...
 

post-465-0-50278000-1462360104_thumb.png

..where we just type/paste in the target for the redirect this shortlink will make and then hit the publish button...

post-465-0-14186000-1462360103_thumb.png

... and we can see the short link and a "Go!" link for testing it.
 

post-465-0-02952800-1462360109_thumb.png

That's about all there is to it except to say that it will help out the ProcessRedirects module if it is installed and you have configured the URL Shortener to help generate names for it.

HTH.

  • Like 4
Link to comment
Share on other sites

I have a quick question (sorry if it was covered I missed it).

If I install Processwire in a directory on my site, let's just say a folder named 'i'.

Would there be a way then that the path to the short link would not include the i in the path, but be made to just use the domain root?

For example:

Crssp.com/i/ujn3gi

vs.

Crssp.com/ujn3gi

Not really a big deal, I'm thinking I will install Processwire in a folder, maybe I should even label the directory pw. :)

Link to comment
Share on other sites

Have there been any thoughts on how or if this could be a publically available service?

I don't think I would ever setup a URL for public use, with so many out there, but would it be doable.

The idea now is it is more of a backend resource rather than frontend, does that sound right?

Link to comment
Share on other sites

  • 2 months later...

Any new activity or use on this one.

Just wondering if anyone if finding good uses, or is using the module.

I got an install of LessN More running today, it has an easy interface.

My only real use case, now is to shorten links in a Tweet, and it will be novel to have my own.

On the backburner will be toying with the module.

It would be useful to shorten the path for news articles on a new beta site, if I can ever manage to get a beta in the wild.

Link to comment
Share on other sites

  • 7 months later...

Hi,
I am trying to get url's mode like www.site.com/artilce instead of www.site.com/parent/page/article. Can I achieve this with the plugin?  So far I don't see such an opportunity. If not, can anyone advice how to do that if possible..

Link to comment
Share on other sites

@xeo, what you want to do is not the intention of the module. In PW the urls follow the structure of the tree, if you would shorten your urls like you are saying, there would be problems with pages overriding other with the same name. Imagine that you have a page called "About" in the root of the website (mydomain.com/about), and you would write an article with the title "About". You would have a problem because they would share the same url.

If you want to have short urls for your articles, you can put them under a parent that is on the root, and has a short name (not short title)

-home
--about
--contacts
--articles (name: a)
---article1
---article2
 

This way, your article1 url would be mydomain/a/article1

If you want to have an even shorter url for the articles (avoiding urls like: mydomain/a/my-new-article-with-a-very-very-veeeeeeeeery-long-title), you can create a system that accepts their IDs on the URL (mydomain/a/123):

<?php

// on top of the template file of the "articles" page ("/a/")
// url segments have to be activated on this template

if ($input->urlSegments) { // if there are segments in the URL

    $id = (int)$input->urlSegment1; // get the first segment ant turn it into an integer
    $myURL = $pages->get("/a/")->find("id={$id}")->first()->url; // get the url of the page with the id in the segment

    if ($myURL && !$input->urlSegment2) { // if page exists and there's not a second segment
        $session->redirect($myURL); // redirect to the correct page
    } else {
        throw new PageNotFoundException(); // if not, throw a 404
    }
}

  • Like 4
Link to comment
Share on other sites

Thanx for the explanation. The problem is not about  the length of urls as such. The reason I want those urls is that pages or articles can be moved from on parent page to another. For example, I have a parent page, say, Poetry and I publish a child page with American poets' stuff, then in the future I may want to divide poetry into American, European etc. poetry pages. Then I have to move my page to the American poetry which is child of the Poetry. In this case my url will be different. I want to avoid it.   

Link to comment
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now
 Share

  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By LuisM
      Symprowire is a PHP MVC Framework based and built on Symfony using ProcessWire 3.x as DBAL and Service-Provider
      It acts as a Drop-In Replacement Module to handle the Request/Response outside the ProcessWire Admin. Even tough Symfony or any other mature MVC Framework could be intimidating at first, Symprowire tries to abstract Configuration and Symfony Internals away as much as possible to give you a quick start and lift the heavy work for you.
      The main Goal is to give an easy path to follow an MVC Approach during development with ProcessWire and open up the available eco-system.
      You can find the GitHub Repo and more Information here: https://github.com/Luis85/symprowire
      Documentation
      The Symprowire Wiki https://github.com/Luis85/symprowire/wiki How to create a simple Blog with Symprowire https://github.com/Luis85/symprowire/wiki/Symprowire-Blog-Tutorial Last Update
      16.07.2021 // RC 1 v0.6.0 centralized ProcessWire access trough out the Application by wrapping to a Service https://github.com/Luis85/symprowire/releases/tag/v0.6.0-rc-1 Requirements
      PHP ^7.4 Fresh ProcessWire ^3.0.181 with a Blank Profile Composer 2 (v1 should work, not recommended) The usual Symfony Requirements Features
      Twig Dependency Injection Monolog for Symprowire Support for .env YAML Configuration Symfony Console and Console Commands Symfony Webprofiler Full ProcessWire access inside your Controller and Services Webpack Encore support Caveats
      Symfony is no small Framework and will come with a price in terms of Memory Usage and added Overhead. To give you a taste I installed Tracy Debugger alongside to compare ProcessWire profiling with the included Symfony Webprofiler

      So in a fresh install Symprowire would atleast add another 2MB of Memory usage and around 40ms in response time, should be less in production due to the added overhead of the Webprofiler in dev env
       
    • By FireWire
      Hello community!

      I want to share a new module I've been working on that I think could be a big boost for multi-language ProcessWire sites.

      Some background, I was looking for a way for our company website to be efficiently translated as working with human translators was pretty laborious and a lack of updating content created a divergence between languages. I, and several other devs here, have talked about translation integrations and have recognized the power that DeepL has. DeepL is an AI deep learning powered service that delivers translation quality beyond any automated service available. After access to the API was opened up to the US, I built Fluency, a DeepL translation integration for ProcessWire.
      Fluency brings automated translation to every multi-language field in the admin, and also provides a translation tool allowing the user to translate their text to any language without it being inside a template's field. With Fluency you can:
      Translate any plain textarea or text input Translate any CKEditor content (yes, with markup) Translate page names for fully localized URLs on every page Translate your in-template translation function wrapped strings Translate modules Fluency is free, and now so is DeepL
      Since this module was first built DeepL has introduced free Developer accounts that allow anyone to start using Fluency at zero cost and beginning with the version 0.3.0 release Fluency now supports free DeepL accounts. As of June 2021 DeepL supports translation to 26 languages and continues to offer more!
      Installation and usage is completely plug and play. Whether you're building a new multi-language site, need to update a site to multi-language, or simply want to stop manually translating a site and make any language a one-click deal, it could not be easier to do it. Fluency works by having you match the languages configured in ProcessWIre to DeepL's. You can have your site translating to any or all of the languages DeepL translates to in minutes (quite literally).
      Let's break out the screenshots...
      When the default language tab is shown, a message is displayed to let users know that translation is available. Clicking on each tab shows a link that says "Translate from English". Clicking it shows an animated overlay with the word "Translating..." cycling through each language and a light gradient shift. Have a CKEditor field? All good. Fluency will translated it and use DeepL's ability to translate text within HTML tags. CKEditor fields can be translated as easily and accurately as text/textarea fields.

      Repeaters and AJAX created fields also have translation enabled thanks to a JavaScript MutationObserver that searches for multi-language fields and adds translation as they're inserted into the DOM. If there's a multi-language field on the page, it will have translation added.

      Same goes for image description fields. Multi-language SEO friendly images are good to go.

      Creating a new page from one of your templates? Translate your title, and also translate your page name for native language URLs. (Not available for Russian, Chinese, or Japanese languages due to URL limitations). These can be changed in the "Settings" tab for any page as well so whether you're translating new pages or existing pages, you control the URLs everywhere.

      Language configuration pages are no different. Translate the names of your languages and search for both Site Translation Files (including all of your modules)

      Translate all of the static text in your templates as well. Notice that the placeholders are retained. DeepL is pretty good at recognizing and keeping non-translatable strings like that. If it is changed, it's easy to fix manually.

      Fluency adds a "Translate" item to the CMS header. When clicked this opens up a modal with a full translation tool that lets the user translate any language to any language. No need to leave the admin if you need to translate content from a secondary language back to the default ProcessWire language. There is also a button to get the current API usage statistics. DeepL account owners can set billing limitations via character count to control costs. This may help larger sites or sites being retrofitted keep an eye on their usage. Fluency can be used by users having roles given the fluency-translate permission.

      It couldn't be easier to add Fluency to your new or existing website. Simply add your API key and you're shown what languages are currently available for translation from/to as provided by DeepL. This list and all configuration options are taken live from the API so when DeepL releases new languages you can add them to your site without any work. No module updates, just an easy configuration. Just match the language you configured in ProcessWire to the DeepL language you want it to be associated with and you're done. Fluency also allows you to create a list of words/phrases that will not be translated which can prevent items such as brands and company names from being translated when they shouldn't

       
      Limitations:
      No "translate page" - Translating multiple fields can be done by clicking multiple translation links on multiple fields at once but engineering a "one click page translate" is not feasible from a user experience standpoint. The time it takes to translate one field can be a second or two, but cumulatively that may take much longer (CKEditor fields are slower than plain text fields). There may be a workaround in the future but it isn't currently on the roadmap. No "translate site" - Same thing goes for translating an entire website at once. It would be great, but it would be a very intense process and take a very (very) long time. There may be a workaround in the future but it isn't on the roadmap. No current support for Inline CKEditor fields - Handling for CKEditor on-demand hasn't been implemented yet, this is planned for a future release though and can be done. I just forgot about it because I've never really used that feature personally.. Alpha release - This module is in alpha. Releases should be stable and usable, but there may be edge case issues. Test the module thoroughly and please report any bugs via a Github issue on the repository or respond here. Please note that the browser plugin for Grammarly conflicts with Fluency (as it does with many web applications). To address this issue it is recommended that you disable Grammarly when using Fluency, or open the admin to edit pages in a private window where Grammarly may not be loaded. This is an issue that may not have a resolution as creating a workaround may not be possible. If you have insight as to how this may be solved please visit the Github page and file a bugfix ticket.
      Requirements:
      ProcessWire  3.0+ UIKit Admin Theme That's Fluency in a nutshell. A core effort in this module is to create it so that there is nothing DeepL related hard-coded in that would require updating it when DeepL offers new languages. I would like this to be a future-friendly module that doesn't require developer work to keep it up-to-date.
      The Module Is Free
      This is my first real module and I want to give it back to the community as thanks. This is the best CMS I've worked with (thank you Ryan & contributors) and a great community (thank you dear reader).
      DeepL Developer Accounts
      In addition to paid Pro Developer accounts, DeepL now offers no-cost free accounts. Now all ProcessWire developers and users can use Fluency at no cost.
      Learn more about free and paid accounts by visiting the DeepL website. Sign up for a Developer account, get an API key, and start using Fluency today.
      Download & Feedback
      Download the latest version here
      https://github.com/SkyLundy/Fluency-Translation/archive/main.zip
      Github repository:
      https://github.com/SkyLundy/Fluency-Translation
      File issues and feature requests here (your feedback and testing is greatly appreciated):
      https://github.com/SkyLundy/Fluency-Translation/issues
       
      Thank you! ¡Gracias! Ich danke Ihnen! Merci! Obrigado! Grazie! Dank u wel! Dziękuję! Спасибо! ありがとうございます! 谢谢你!

    • By tcnet
      PageViewStatistic for ProcessWire is a module to log page visits of the CMS. The records including some basic information like IP-address, browser, operating system, requested page and originate page. Please note that this module doesn't claim to be the best or most accurate.
      Advantages
      One of the biggest advantage is that this module doesn't require any external service like Google Analytics or similar. You don't have to modify your templates either. There is also no Javascript or image required.
      Disadvantages
      There is only one disadvantage. This module doesn't record visits if the browser loads the page from its browser cache. To prevent the browser from loading the page from its cache, add the following meta tags to the header of your page:
      <meta http-equiv="Cache-Control" content="no-cache, no-store, must-revalidate" /> <meta http-equiv="Pragma" content="no-cache" /> <meta http-equiv="Expires" content="0" /> How to use
      The records can be accessed via the Setup-menu of the CMS backend. The first dropdown control changes the view mode.

      Detailed records
      View mode "Detailed records" shows all visits of the selected day individually with IP-address, browser, operating system, requested page and originate page. Click the update button to see new added records.

      Cached visitor records
      View modes other than "Detailed records" are cached visitor counts which will be collected on a daily basis from the detailed records. This procedure ensures a faster display even with a large number of data records. Another advantage is that the detailed records can be deleted while the cache remains. The cache can be updated manually or automatically in a specified time period. Multiple visits from the same IP address on the same day are counted as a single visitor.

      Upgrade from older versions
      Cached visitor counts is new in version 1.0.8. If you just upgraded from an older version you might expire a delay or even an error 500 if you display cached visitor counts. The reason for this is that the cache has to be created from the records. This can take longer if your database contains many records. Sometimes it might hit the maximally execution time. Don't worry about that and keep reloading the page until the cache is completely created.
      Special Feature
      PageViewStatistic for ProcessWire can record the time a visitor viewed the page. This feature is deactivated by default. To activate open the module configuration page and activate "Record view time". If activated you will find a new column "S." in the records which means the time of view in seconds. With every page request, a Javascript code is inserted directly after the <body> tag. Every time the visitor switches to another tab or closes the tab, this script reports the number of seconds the tab was visible. The initial page request is recorded only as a hyphen (-).

      New in version 1.1.0
      A new feature comes with version 1.1.0 which offers to record user names of loggedin visitors. Just activate "Record user names" and "Record loggedin user" in the module settings.
      Settings
      You can access the module settings by clicking the Configuration button at the bottom of the records page. The settings page is also available in the menu: Modules->Configure->ProcessPageViewStat.
      IP2Location
      This module uses the IP2Location database from: http://www.ip2location.com. This database is required to obtain the country from the IP address. IP2Location updates this database at the begin of every month. The settings of ProcessPageViewStat offers the ability to automatically download the database monthly. Please note, that automatically download will not work if your webspace doesn't allow allow_url_fopen.
      Dragscroll
      This module uses DragScroll. A JavaScript available from: http://github.com/asvd/dragscroll. Dragscroll adds the ability in view mode "Day" to drag the records horizontally with the mouse pointer.
      parseUserAgentStringClass
      This module uses the PHP class parseUserAgentStringClass available from: http://www.toms-world.org/blog/parseuseragentstring/. This class is required to filter out the browser type and operating system from the server request.
    • By clsource
      Inertia Adapter ProcessWire Module
      Hello! Long time no see.
      I created this module so you can use Inertia.js (https://inertiajs.com/) with ProcessWire.
      Description
      Inertia allows you to create fully client-side rendered, single-page apps, without much of the complexity that comes with modern SPAs. It does this by leveraging existing server-side frameworks.
      Inertia isn’t a framework, nor is it a replacement to your existing server-side or client-side frameworks. Rather, it’s designed to work with them. Think of Inertia as glue that connects the two. Inertia comes with three official client-side adapters (React, Vue, and Svelte).
      This is an adapter for ProcessWire. Inertia replaces PHP views altogether by returning JavaScript components from controller actions. Those components can be built with your frontend framework of choice.
      Links
      - https://github.com/joyofpw/inertia
      - https://github.com/joyofpw/inertia-svelte-mix-pw
      - https://inertiajs.com/
      Screenshots


       
    • By sms77io
      Hi all,
      we made a small module for sending SMS via Sms77.io. It supports sending to one and multiple users.
      You can download it from GitHub and follow the instructions on how to install it - it is quite easy. An API key is required for sending, get yours for free @ Sms77 and receive 0,50 €.
      Hope this helps somebody and we are open for improvement suggestions!
       
      Best regards
      André
×
×
  • Create New...