Jump to content

Recommended Posts

Jumplinks for ProcessWire

Release: 1.5.60
Composer: rockett/jumplinks

⚠️ NOTICE: 1.5.60 is an important security patch-release for an XSS vulnerability discovered by @phlp. It's HIGHLY RECOMMENDED that all Jumplinks users update to the latest version as soon as possible.

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! 🙂

Edited by Mike Rockett
Security Release
  • 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 Gadgetto
      SnipWire - Snipcart integration for ProcessWire
      Snipcart is a powerful 3rd party, developer-first HTML/JavaScript shopping cart platform. SnipWire is the missing link between Snipcart and the content management framework ProcessWire.
      With SnipWire, you can quickly turn any ProcessWire site into a Snipcart online shop. The SnipWire plugin helps you to get your store up and running in no time. Detailed knowledge of the Snipcart system is not required.
      SnipWire is free and open source licensed under Mozilla Public License 2.0! A lot of work and effort has gone into development. It would be nice if you could donate an amount to support further development:

      Status update links (inside this thread) for SnipWire development
      2020-01-21 -- Snipcart v3 - when will the new cart system be implemented? 2020-01-19 -- integrated taxes provider finished (+ very flexible shipping taxes handling) 2020-01-14 -- new date range picker, discount editor, order notifiactions, order statuses, and more ... 2019-11-15 -- orders filter, order details, download + resend invoices, refunds 2019-10-18 -- list filters, REST API improvements, new docs platform, and more ... 2019-08-08 -- dashboard interface, currency selector, managing Orders, Customers and Products, Added a WireTabs, refinded caching behavior 2019-06-15 -- taxes provider, shop templates update, multiCURL implementation, and more ... 2019-06-02 -- FieldtypeSnipWireTaxSelector 2019-05-25 -- SnipWire will be free and open source Plugin Key Features
      Fast and simple store setup Full integration of the Snipcart dashboard into the ProcessWire backend (no need to leave the ProcessWire admin area) Browse and manage orders, customers, discounts, abandoned carts, and more Process refunds and send customer notifications from within the ProcessWire backend Process Abandoned Carts + sending messages to customers from within the ProcessWire backend Complete Snipcart webhooks integration (all events are hookable via ProcessWire hooks) Integrated taxes provider (which is more flexible then Snipcart own provider) Useful Links
      SnipWire in PW modules directory (alpha version only available via GitHub) SnipWire Docs (please note that the documentation is a work in progress) SnipWire @GitHub (feature requests and suggestions for improvement are welcome - I also accept pull requests) Snipcart Website  
      ---- INITIAL POST FROM 2019-05-25 ----
       
    • By d'Hinnisdaël
      Happy new year, everybody 🥬
      I've been sitting on this Dashboard module I made for a client and finally came around to cleaning it up and releasing it to the wider public. This is how it looks.
      ProcessWire Dashboard

      If anyone is interested in trying this out, please go ahead! I'd love to get some feedback on it. If this proves useful and survives some real-world testing, I'll add this to the module directory.
      Download
      You can find the latest release on Github.
      Documentation
      Check out the documentation to get started. This is where you'll find information about included panel types and configuration options.
      Custom Panels
      My goal was to make it really simple to create custom panels. The easiest way to do that is to use the panel type template and have it render a file in your templates folder. This might be enough for 80% of all use cases. For anything more complex (FormBuilder submissions? Comments? Live chat?), you can add new panel types by creating modules that extend the DashboardPanel base class. Check out the documentation on custom panels or take a look at the HelloWorld panel to get started. I'm happy to merge any user-created modules into the main repo if they might be useful to more than a few people.
       Disclaimer
      This is a pre-release version. Please treat it as such — don't install it on production sites. Just making sure 🍇
      Roadmap
      These are the things I'm looking to implement myself at some point. The wishlist is a lot longer, but those are the 80/20 items that I probably won't regret spending time on.
      Improve documentation & add examples ⚙️ Panel types Google Analytics ⚙️ Add new page  🔥 Drafts 🔥 At a glance / Page counter 404s  Layout options Render multiple tabs per panel panel groups with heading and spacing between ✅ panel wrappers as grid item (e.g. stacked notices) ✅ Admin themes support AdminThemeReno and AdminThemeDefault ✅ Shortcuts panel add a table layout with icon, title & summary ✅ Chart panel add default styles for common chart types ✅ load chart data from JS file (currently passed as PHP array) Collection panel support image columns ✅ add buttons: view all & add new ✅
    • By Robin S
      This module is inspired by and similar to the Template Stubs module. The author of that module has not been active in the PW community for several years now and parts of the code for that module didn't make sense to me, so I decided to create my own module. Auto Template Stubs has only been tested with PhpStorm because that is the IDE that I use.
      Auto Template Stubs
      Automatically creates stub files for templates when fields or fieldgroups are saved.
      Stub files are useful if you are using an IDE (e.g. PhpStorm) that provides code assistance - the stub files let the IDE know what fields exist in each template and what data type each field returns. Depending on your IDE's features you get benefits such as code completion for field names as you type, type inference, inspection, documentation, etc.
      Installation
      Install the Auto Template Stubs module.
      Configuration
      You can change the class name prefix setting in the module config if you like. It's good to use a class name prefix because it reduces the chance that the class name will clash with an existing class name.
      The directory path used to store the stub files is configurable.
      There is a checkbox to manually trigger the regeneration of all stub files if needed.
      Usage
      Add a line near the top of each of your template files to tell your IDE what stub class name to associate with the $page variable within the template file. For example, with the default class name prefix you would add the following line at the top of the home.php template file:
      /** @var tpl_home $page */ Now enjoy code completion, etc, in your IDE.

      Adding data types for non-core Fieldtype modules
      The module includes the data types returned by all the core Fieldtype modules. If you want to add data types returned by one or more non-core Fieldtype modules then you can hook the AutoTemplateStubs::getReturnTypes() method. For example, in /site/ready.php:
      // Add data types for some non-core Fieldtype modules $wire->addHookAfter('AutoTemplateStubs::getReturnTypes', function(HookEvent $event) { $extra_types = [ 'FieldtypeDecimal' => 'string', 'FieldtypeLeafletMapMarker' => 'LeafletMapMarker', 'FieldtypeRepeaterMatrix' => 'RepeaterMatrixPageArray', 'FieldtypeTable' => 'TableRows', ]; $event->return = $event->return + $extra_types; }); Credits
      Inspired by and much credit to the Template Stubs module by mindplay.dk.
       
      https://github.com/Toutouwai/AutoTemplateStubs
      https://modules.processwire.com/modules/auto-template-stubs/
    • By Robin S
      Add Image URLs
      Allows images/files to be added to Image/File fields by pasting URLs.

      Usage
      Install the Add Image URLs module.
      A "Paste URLs" button will be added to all image and file fields. Use the button to show a textarea where URLs may be pasted, one per line. Images/files are added when the page is saved.
       
      https://github.com/Toutouwai/AddImageUrls
      https://modules.processwire.com/modules/add-image-urls/
    • By gebeer
      Hello all,
      sharing my new module FieldtypeImageReference. It provides a configurable input field for choosing any type of image from selectable sources. Sources can be: 
      a predefined folder in site/templates/ and/or a  page (and optionally its children) and/or the page being edited and/or any page on the site CAUTION: this module is under development and not quite yet in a production-ready state. So please test it carefully.
      UPDATE: the new version v2.0.0 introduces a breaking change due to renaming the module. If you have an older version already installed, you need to uninstall it and install the latest master version.
      Module and full description can be found on github https://github.com/gebeer/FieldtypeImageReference
      Install from URL: https://github.com/gebeer/FieldtypeImageReference/archive/master.zip
      Read on for features and use cases.
      Features
      Images can be loaded from a folder inside site/templates/ or site/assets Images in that folder can be uploaded and deleted from within the inputfield Images can be loaded from other pages defined in the field settings Images can be organized into categories. Child pages of the main 'image source page' serve as categories mages can be loaded from any page on the site From the API side, images can be manipulated like native ProcessWire images (resizing, cropping etc.), even the images from a folder Image thumbnails are loaded into inputfield by ajax on demand Source images on other pages can be edited from within this field. Markup of SVG images can be rendered inline with `echo $image->svgcontent` Image names are fully searchable through the API $pages->find('fieldname.filename=xyz.png'); $pages->find('fieldname.filename%=xy.png'); Accidental image deletion is prevented. When you want to delete an image from one of the pages that hold your site-wide images, the module searches all pages that use that image. If any page contains a reference to the image you are trying to delete, deletion will be prevented. You will get an error message with links to help you edit those pages and remove references there before you can finally delete the image. This field type can be used with marcrura's Settings Factory module to store images on settings pages, which was not possible with other image field types When to use ?
      If you want to let editors choose an image from a set of images that is being used site-wide. Ideal for images that are being re-used across the site (e.g. icons, but not limited to that).
      Other than the native ProcessWire images field, the images here are not stored per page. Only references to images that live on other pages or inside a folder are stored. This has several advantages:
      one central place to organize images when images change, you only have to update them in one place. All references will be updated, too. (Provided the name of the image that has changed stays the same) Installation and setup instructions can be found on github.
      Here's how the input field looks like in the page editor:

      If you like to give it a try, I'm happy to hear your comments or suggestions for improvement. Install from URL: https://github.com/gebeer/FieldtypeImageReference/archive/master.zip
      Eventually this will go in the module directory, too. But it needs some more testing before I submit it. So I'd really appreciate your assistance.
      Thanks to all who contributed their feedback and suggestions which made this module what it is now.
       
×
×
  • Create New...