Jump to content

Recommended Posts

Jumplinks for ProcessWire

Release: 1.5.51

Jumplinks is an enhanced version of the original ProcessRedirects by Antti Peisa.

The Process module manages your permanent and temporary redirects (we'll call these "jumplinks" from now on, unless in reference to redirects from another module), useful for when you're migrating over to ProcessWire from another system/platform. Each jumplink supports wildcards, shortening the time needed to create them.

Unlike similar modules for other platforms, wildcards in Jumplinks are much easier to work with, as Regular Expressions are not fully exposed. Instead, parameters wrapped in curly braces are used - these are described in the documentation.

Under Development: 2.0, to be powered by FastRoute

As of version 1.5.0, Jumplinks requires at least ProcessWire 2.6.1 to run.

View on GitLab
Download via the Modules Directory
Read the docs

Features

The most prominent features include:

  • Basic jumplinks (from one fixed route to another)
  • Parameter-based wildcards with "Smart" equivalents
  • Mapping Collections (for converting ID-based routes to their named-equivalents without the need to create multiple jumplinks)
  • Destination Selectors (for finding and redirecting to pages containing legacy location information)
  • Timed Activation (activate and/or deactivate jumplinks at specific times)
  • 404-Monitor (for creating jumplinks based on 404 hits)

Additionally, the following features may come in handy:

  • Stale jumplink management
  • Legacy domain support for slow migrations
  • An importer (from CSV or ProcessRedirects)

Feedback & Feature Requests

I’d love to know what you think of this module. Please provide some feedback on the module as a whole, or even regarding smaller things that make it whole. Also, please feel free to submit feature requests and their use-cases.

Note: Features requested so far have been added to the to-do list, and will be added to 2.0, and not the current dev/master branches.

Open Source

Jumplinks is an open-source project, and is free to use. In fact, Jumplinks will always be open-source, and will always remain free to use. Forever. If you would like to support the development of Jumplinks, please consider making a small donation via PayPal.

Enjoy!  :grin:

  • Like 24

Share this post


Link to post
Share on other sites

Wow!  Nice work Mike!  I'll try to carve some time later in the week to give this a thorough test run.

  • Like 1

Share this post


Link to post
Share on other sites

I've made few changes, which I'll be uploading tomorrow morning as v0.1.1. Some of it is to do with bettering my code (specifically in the way of Regular Expressions), and the rest of it is to do with better path cleaning, and a few backend CSS fixes.

  • Like 1

Share this post


Link to post
Share on other sites

<development post>

New Alpha Release - 0.1.1

The full changelog is below, but I want to highlight an important addition to the module. In its present state, this  new feature is classified as an experiment, and so it may not make it into the final 1.0 release.

The experiment is called Enhanced Path Cleaning which basically splits and hyphenates TitleCased wildcard-captures, as well as those containing abbreviations or acronyms in capital letters.

This is quite handy for those who come from a DNN background, or some other ASP-based framework.

As an example, EnvironmentStudy would become environment-study and NASALaunch would become nasa-launch.

It also changes any numbers that are not broken out with hyphens.

You'll need to turn the experiment on in the module's config page, as it is off by default.

Example from scan log:

Page not found; scanning for redirects...

    - Checked at: Tue, 06 Jan 2015 10:20:20 +0200
    - Requested URL:
http://processwire.local/NAGMagazine/home/tabid/1027/default.aspx
    - PW Version: 2.5.13

[ASPX Content]

    - Source Path (Unescaped): {path}/tabid/{id}/Default.aspx
    - Source Path (Stage 1): {path:segments}/tabid/{id:num}/Default.aspx
    - Source Path (Stage 2): ([\w/_-]+)/tabid/(\d+)/Default.aspx
    - Destination Path (Original): {path}/?otid={id}
    - Destination Path (Compiled): processwire.local/{path}/?otid={id}
    - Destination Path (Converted): processwire.local/nag-magazine/home/?otid=1027

Match found! We'll do the following redirect (301, permanent) when Debug Mode has been turned off:

    - From URL: processwire.local/NAGMagazine/home/tabid/1027/default.aspx
    - To URL: processwire.local/nag-magazine/home/?otid=1027

Changelog

[5 Jan]

- Modified Module Config page
- Simplified wildcard and cleanPath() expressions
- Added 'segments' check to 'segments' smart wildcard, where only 'path' existed before
- Added 'num' check to 'num'
- Changed ellipses style (added border)
- Made Legacy Redirects temporary (302)
- Fixed CSS #ModuleEditForm declaration so other modules are not impacted by the style change
- Changed CSS p.notes to p.parNotes so we don't conflict with anything else
- Other small semantic code modifications

[6 Jan]
- Added Experiments fieldset in Module Config
- Added Enhanced Path Cleaning Experiment
- Removed license file, refer to
http://mikeanthony.mit-license.org/

  • Like 2

Share this post


Link to post
Share on other sites

Sometimes during a migration people have second thoughts and want to make some adjustments after redirects are in place. How about an option to redirect as 302 for a while (think of it as a probationary period) before automatically converting to 301 (so we don't forget).

  • Like 1

Share this post


Link to post
Share on other sites

Thanks for bringing that up, Steve. I did indeed think about this earlier, and made a comment on my to do list: "Find out if we should prevent the deletion of 301s".

Granted, that isn't the right question to ask, but it reminds me to look at the various options regarding this.

I think your idea is quite good. After such period, should we prevent the deletion of redirects?

And what does everyone else think about this?

Share this post


Link to post
Share on other sites

<development post>

New Alpha Release - 0.1.2 (Breaking Changes)
 
This module introduces a new feature: Mapping Collections (this is the final name for it).
 
The feature allows you to map key/value pairs to your redirects so that you need not repeat yourself.

An example would be the following: Redirect /blog.php?id=2309 to /hello-world/, by using the following redirect:

blog.php?id={id}      =>      {id|pages}

You're wondering, what's {id|blog}? Simply put, that's called a mapping reference, which refers to an entry in a Mapping Collection.

A Mapping Collection, in this case, would look something like this:

1=a-post
2=another-post
3=third-post
...
2309=hello-world

So, when it comes time to redirect, it will scan the provided id against the collection called blog and, if it finds a match, will redirect accordingly.

If, however, there is no match, the segment that asked for the mapping will be left out, resulting in an invalid URL. I may get it to insert the original capture instead.

Some Screenshots:

post-2289-0-00830100-1420570260_thumb.pn

--

post-2289-0-03432300-1420568167_thumb.pn

--

post-2289-0-99072900-1420568173_thumb.pn

--

Full Changelog for this release:

[6 Jan]
- Some refactoring; moving code blocks from main module to UtilityProcess
- [New Feature] Mapping Collections
- Changed module title to Advanced Redirects [ALPHA]
 
Breaking Changes: The DB schemas have changed in this release. If you already have 0.1.0 or 0.1.1 installed, please uninstall it first.
  • Like 3

Share this post


Link to post
Share on other sites

At this point, the module is quite feature-rich. As such, I'm pausing development. This gives time for those testing the module to do so without me introducing new things every three seconds, and it also gives me time to prepare for the whole 'back to work' thing - I return on Monday, and need to prepare for it.

I'll still be here to discuss things, but there won't be any changes for about two weeks.

Looking forward to the results/feedback of everyone's testing. :)

Update: Lol, the stuff I had to do couldn't be done today - so there are a few changes up on the repo now.

  • Like 1

Share this post


Link to post
Share on other sites

<development post>

Right, in terms of features: I need feedback. As mentioned, the module is feature-rich in its current state. Normal and wildcard redirects, along with mapping collections, makes this module ready for almost anything. But there are two features which I haven't implemented yet. They are:

Variables

This is probably something that may never get used. I needed it once upon a time for social accounts and user names, but it really doesn't seem practical. The idea is this: You create a redirect, and use {@something} somewhere in the destination path. Based on your variables table, it would then be replaced accordingly. Like I said, doesn't seem to be something that anyone would really make use of. However, I would like some feedback on it.

Just in Time Replacements

These would probably be used much more - they are quite handy. Say, for example, you had the following page structure in your old site:

  1. About Us.html
  2. Services.html
  3. Contact Us.html

Then you have the following redirect set up:

Source Path: {page:any}.html

Destination Path: {page}/

Naturally, those pages would redirect to:

  1. about-us/
  2. services/
  3. contact-us/

But now, you've decided to use different page names in your new PW site - for example: who-we-are, solutions, and connect.

Considering we're using a wildcard redirect here (saves time for a lot of pages), we don't want define more redirects to go the new pages. This is where JIT Replacements comes in. It's like a simple find and replace:

Find                                                    Replace

about-us                      who-we-are

services                      solutions

contact-us                    connect

 

 

And, therefore:

Request                                             Destination

About Us.html                 who-we-are/

Services.html                 solutions/

Contact Us.html               connect/

 

In a nutshell, this saves a redirect. One might argue that they may as well create redirects for each and every page, but you have to consider that not every page name will change. And what happens if you move all the pages down a level? You'd only need to change one redirect.

So, I'd like some feedback on this too. Will you find it useful?

Until I've got some decent feedback, I'm not going to add these features. With that said, and because I know some people are eager to use the module now, I'm going to release a beta. I haven't found any bugs as yet, and so I think its ready for beta status.


(Oh, and I'll add the history feature before beta release - nearly forgot about that!)

Share this post


Link to post
Share on other sites

Mike, my humble opinion, that you have already huge amount of features. Adding more makes starting to use this module in simpler cases more difficult: "I installed it and it felt like total overkill for my needs.". Of course we have the current redirects module for those needs... But I think your feature set is great and would much rather see the current as stable instead of more scenarios supported.

Share this post


Link to post
Share on other sites

Okay - I understand where you're coming from.

Do you think it would be useful to have a redirect log? Or just a simple hit counter like you had?

And have you encountered any problems as yet?

Share this post


Link to post
Share on other sites

Nearly done with the importing side of things. Hit counter will be quick and easy.

Last thing I need to ask:

Currently, a 302 redirect will occur if it has a start/end time assigned. Otherwise, it will do a 301. Should we include functionality to let the end-user choose if it should be 301/302? Or should we stick with the previous idea of a probation period?

Share this post


Link to post
Share on other sites

Just pushed 0.9.1 to the repo. Sorry, haven't had time to finish up faster.

Importing from CSV is done (seemingly). Will also support importing from Redirects module, if you don't want to run both.

  • Like 1

Share this post


Link to post
Share on other sites

Okay, so I've actually decided to rename the module to ProcessJumplinks. I prefer it.

https://github.com/mike-anthony/ProcessJumplinks

Hit counter is done. Still need to work on importing from Redirects module - I'll do that tomorrow as I'm super-tired now.

I don't think I'm going to make this compatible with the current stable (2.5.3). If you really want me to, please let me know.

:-)


Will also work on docs soon - though my intro post covers a lot. Nice to have docs, however.

  • Like 5

Share this post


Link to post
Share on other sites

Hi Pete - I will do so shortly. Thanks.

Edit - though, the module isn't compatible with 2.5, so I can't add it... Could we perhaps add a 2.6-dev to that list?

  • Like 2

Share this post


Link to post
Share on other sites

Hey Mike - any thoughts of making is possible to add redirects via an API call. After the discussion this morning about imported Wordpress rewriting (https://processwire.com/talk/topic/8869-wordpress-url-rewrites/), I would like to add this functionality to MigratorWordpress so that rewrites are automatically added. Obviously I can do it through SQL inserts, but thought an API method would be nice.

  • Like 1

Share this post


Link to post
Share on other sites

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.

Guest
Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.


  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By Robin S
      A community member raised a question and I thought a new sanitizer method for the purpose would be useful, hence...
      Sanitizer Transliterate
      Adds a transliterate method to $sanitizer that performs character replacements as defined in the module config. The default character replacements are based on the defaults from InputfieldPageName, but with uppercase characters included too.
      Usage
      Install the Sanitizer Transliterate module.
      Customise the character replacements in the module config as needed.
      Use the sanitizer on strings like so:
      $transliterated_string = $sanitizer->transliterate($string);
       
      https://github.com/Toutouwai/SanitizerTransliterate
      https://modules.processwire.com/modules/sanitizer-transliterate/
       
    • By dimitrios
      Hello,
      this module can publish content of a Processwire page on a Facebook page, triggered by saving the Processwire page.
      To set it up, configure the module with a Facebook app ID, secret and a Page ID. Following is additional configuration on Facebook for developers:
      Minimum Required Facebook App configuration:
      on Settings -> Basics, provide the App Domains, provide the Site URL, on Settings -> Advanced, set the API version to 2.10, add Product: Facebook Login, on Facebook Login -> Settings, set Client OAuth Login: Yes, set Web OAuth Login: Yes, set Enforce HTTPS: Yes, add "http://www.example.com/processwire/page/" to field Valid OAuth Redirect URIs. This module is configurable as follows:
      Templates: posts can take place only for pages with the defined templates. On/Off switch: specify a checkbox field that will not allow the post if checked. Specify a message and/or an image for the post.
      Usage
      edit the desired PW page and save; it will post right after the initial Facebook log in and permission granting. After that, an access token is kept.
       
      Download
      PW module directory: http://modules.processwire.com/modules/auto-fb-post/ Github: https://github.com/kastrind/AutoFbPost   Note: Facebook SDK for PHP is utilized.


    • By thomasaull
      I created a little helper module to trigger a CI pipeline when your website has been changed. It's quite simple and works like this: As soon as you save a page the module sets a Boolean via a pages save after hook. Once a day via LazyCron the module checks if the Boolean is set and sends a POST Request to a configurable Webhook URL.
      Some ideas to extend this:
      make request type configurable (GET, POST) make the module trigger at a specified time (probably only possible with a server cronjob) trigger manually Anything else? If there's interest, I might put in some more functionality. Let me know what you're interested in. Until then, maybe it is useful for a couple of people 🙂
      Github Repo: https://github.com/thomasaull/CiTrigger
    • By Robin S
      I created this module a while ago and never got around to publicising it, but it has been outed in the latest PW Weekly so here goes the support thread...
      Unique Image Variations
      Ensures that all ImageSizer options and focus settings affect image variation filenames.

      Background
      When using methods that produce image variations such as Pageimage::size(), ProcessWire includes some of the ImageSizer settings (height, width, cropping location, etc) in the variation filename. This is useful so that if you change these settings in your size() call a new variation is generated and you see this variation on the front-end.
      However, ProcessWire does not include several of the other ImageSizer settings in the variation filename:
      upscaling cropping, when set to false or a blank string interlace sharpening quality hidpi quality focus (whether any saved focus area for an image should affect cropping) focus data (the top/left/zoom data for the focus area) This means that if you change any of these settings, either in $config->imageSizerOptions or in an $options array passed to a method like size(), and you already have variations at the requested size/crop, then ProcessWire will not create new variations and will continue to serve the old variations. In other words you won't see the effect of your changed ImageSizer options on the front-end until you delete the old variations.
      Features
      The Unique Image Variations module ensures that any changes to ImageSizer options and any changes to the focus area made in Page Edit are reflected in the variation filename, so new variations will always be generated and displayed on the front-end.
      Installation
      Install the Unique Image Variations module.
      In the module config, set the ImageSizer options that you want to include in image variation filenames.
      Warnings
      Installing the module (and keeping one or more of the options selected in the module config) will cause all existing image variations to be regenerated the next time they are requested. If you have an existing website with a large number of images you may not want the performance impact of that. The module is perhaps best suited to new sites where image variations have not yet been generated.
      Similarly, if you change the module config settings on an existing site then all image variations will be regenerated the next time they are requested.
      If you think you might want to change an ImageSizer option in the future (I'm thinking here primarily of options such as interlace that are typically set in $config->imageSizerOptions) and would not want that change to cause existing image variations to be regenerated then best to not include that option in the module config after you first install the module.
       
      https://github.com/Toutouwai/UniqueImageVariations
      https://modules.processwire.com/modules/unique-image-variations/
    • By Sebi
      I've created a small module which lets you define a timestamp after which a page should be accessible. In addition you can define a timestamp when the release should end and the page should not be accessable any more.
      ProcessWire-Module: http://modules.processwire.com/modules/page-access-releasetime/
      Github: https://github.com/Sebiworld/PageAccessReleasetime
      Usage
      PageAccessReleasetime can be installed like every other module in ProcessWire. Check the following guide for detailed information: How-To Install or Uninstall Modules
      After that, you will find checkboxes for activating the releasetime-fields at the settings-tab of each page. You don't need to add the fields to your templates manually.
      Check e.g. the checkbox "Activate Releasetime from?" and fill in a date in the future. The page will not be accessable for your users until the given date is reached.
      If you have $config->pagefileSecure = true, the module will protect files of unreleased pages as well.
      How it works
      This module hooks into Page::viewable to prevent users to access unreleased pages:
      public function hookPageViewable($event) { $page = $event->object; $viewable = $event->return; if($viewable){ // If the page would be viewable, additionally check Releasetime and User-Permission $viewable = $this->canUserSee($page); } $event->return = $viewable; } To prevent access to the files of unreleased pages, we hook into Page::isPublic and ProcessPageView::sendFile.
      public function hookPageIsPublic($e) { $page = $e->object; if($e->return && $this->isReleaseTimeSet($page)) { $e->return = false; } } The site/assets/files/ directory of pages, which isPublic() returns false, will get a '-' as prefix. This indicates ProcessWire (with activated $config->pagefileSecure) to check the file's permissions via PHP before delivering it to the client.
      The check wether a not-public file should be accessable happens in ProcessPageView::sendFile. We throw an 404 Exception if the current user must not see the file.
      public function hookProcessPageViewSendFile($e) { $page = $e->arguments[0]; if(!$this->canUserSee($page)) { throw new Wire404Exception('File not found'); } } Additionally we hook into ProcessPageEdit::buildForm to add the PageAccessReleasetime fields to each page and move them to the settings tab.
      Limitations
      In the current version, releasetime-protected pages will appear in wire('pages')->find() queries. If you want to display a list of pages, where pages could be releasetime-protected, you should double-check with $page->viewable() wether the page can be accessed. $page->viewable() returns false, if the page is not released yet.
      If you have an idea how unreleased pages can be filtered out of ProcessWire selector queries, feel free to write an issue, comment or make a pull request!
×
×
  • Create New...