What does it do? 

It converts a normal URL to a tiny URL. It works similar as services provided by https://bitly.com/ or http://tinyurl.com/ .

It has multiple integration options. You can create tiny URLs in the backend by adding a tiny URL database record. You can convert any typolink to a tinyurl by simply adding some configuration options. And you can use the API of this extension to create tiny URLs in your own extensions.

Screenshots 

Settings for a tiny URL in the Backend;

Usage 

You can either use the extension as an administrator / integrator by using additional TypoScript (see Administrator Manual section) or as a developer by using the API of the extension (see Developer Corner section).

In-depth information 

Installation 

The first step, to get this extension up and running is importing it in the extension manager and install it.

Alternatively you can use composer to install the extension:

composer require de-swebhosting-typo3-extension/tinyurls

Then you can edit the extension configuration according to your needs.

Now you are able to create and use tiny URLs in your TYPO3 instance.

Editing tiny URL records 

Once the extension is installed you can add tiny URLs in the TYPO3 backend. If you didn't change the default value of urlRecordStoragePID in the extension configuration you must add the records in the TYPO3 root. Otherwise you can add them in the page (folder) with the PID you specified in the config.

Using tinyurls in TypoScript 

You can convert any typolink to a tinyurl by simply setting the property tinyurl to 1. For more information about the TypoScript configuration options please have a look in the TypoScript configuration section.

This is a quick example:

page.30 = TEXT
page.30 {
		value = Permalink
		typolink = 1
		typolink.parameter.data = getIndpEnv:REQUEST_URI
		typolink.tinyurl = 1
}

Further information 

Apache example configuration 

When you are using mod_rewrite you can use this line in your .htaccess file or your webserver configuration:

RewriteRule ^tinyurl/([a-zA-Z0-9]+(-[a-zA-Z0-9]+)?)$ /index.php?eID=tx_tinyurls&tx_tinyurls[key]=$1

Lighttpd example configuration 

When you use lighttpd you can use this configuration for rewriting tiny URLs:

url.rewrite-if-not-file = (
    # rewrite goto urls to tinyurls extension
    "^/tinyurl/(.*)$" => typo3path + "index.php?eID=tx_tinyurls&tx_tinyurls[key]=$1",
)

What gets migrated 

For every tx_tinyurls_urls record found on the given storage PID, the command creates one sys_redirect record:

The redirect is always created with target_statuscode 301 (permanent redirect).

Records where valid_until is in the past are migrated as well, with the same (past) timestamp carried over to endtime. The resulting redirect is therefore created already expired. Nothing in tx_tinyurls_urls is deleted by this command, so it is entirely up to you whether to keep, disable or remove those expired redirects afterward.

The following records are skipped and left untouched in tx_tinyurls_urls:

• Records with delete_on_use enabled. Redirects have no "delete after first hit" concept, so a one-time-use tiny URL would silently become a permanent redirect if it was migrated. If you still need these, note them down before migrating, since the command has no way to recreate their one-time behaviour on the redirects side.
• Records for which a matching redirect (same --host and resulting source_path) already exists. This makes the command safe to run multiple times, for example to pick up tiny URLs that were created after an earlier migration run.

If you are not using speaking URLs 

By default, a tiny URL is accessed as index.php?eID=tx_tinyurls&tx_tinyurls[key]=<urlkey> (see What does it do?), unless you enabled Speaking URL configuration. Because of this, the command cannot derive a sensible default for --url-template when speaking URLs are disabled and requires you to pass it explicitly. The --url-template option builds a plain path (for example /<urlkey>), which matches speaking URLs but not the default eID query string. If you are not using speaking URLs, links generated by the migration will not automatically catch requests to the old eID URLs.

In that case, either keep this extension installed until you have confirmed that external links, bookmarks and search engine listings have moved over to the new redirect URLs, enable speaking URLs before migrating so that old and new URLs match, or add a webserver-level rewrite that forwards the old eID URLs to the new path, as described below.

Redirecting old eID URLs at the webserver 

If you were not using speaking URLs, you can add a rewrite rule that translates requests for the old index.php?eID=tx_tinyurls&tx_tinyurls[key]=<urlkey> URLs into the path used by --url-template, so that old links keep working without keeping this extension installed. The webserver issues a redirect to the new path, which TYPO3 then matches against the migrated sys_redirect record and redirects to the final target — one extra hop, but only for old links still in circulation.

The examples below assume the default --url-template of /tinyurl/###TINY_URL_KEY###; adjust the target path to whatever template you actually used. They also assume the default base62Dictionary (alphanumeric characters); widen the character class if you configured a custom dictionary.

RewriteEngine On
RewriteCond %{QUERY_STRING} ^eID=tx_tinyurls&tx_tinyurls\[key\]=([A-Za-z0-9-]+)$
RewriteRule ^index\.php$ /tinyurl/%1? [R=301,L]

if ($args ~ "^eID=tx_tinyurls&tx_tinyurls\[key\]=([A-Za-z0-9-]+)$") {
    return 301 /tinyurl/$1;
}

Usage 

Run the command with TYPO3 Console (or via vendor/bin/typo3 on TYPO3 v10+):

vendor/bin/typo3 tinyurls:migrate-to-redirects --pid <storage-pid>

Always do a dry run first to see how many records would be migrated (this includes already-expired tiny URLs, see What gets migrated), skipped or have already been migrated, without writing anything to the database:

vendor/bin/typo3 tinyurls:migrate-to-redirects --pid <storage-pid> --dry-run

The command processes records in batches, so it works the same way regardless of how many tiny URLs you have.

Options 

If your tiny URLs are spread across multiple storage pages (for example one per site), run the command once per --pid, adjusting --host and --url-template for each site as needed.

Recommended workflow 

1. Update to the latest release of this extension and make sure EXT:redirects is active.
2. Run the command with --dry-run and check the summary output.
3. Run it for real, with --host and --url-template matching your setup.
4. Check the created records in the backend Redirects module.
5. If you were not using speaking URLs, add the webserver rewrite described in Redirecting old eID URLs at the webserver so that old links keep working.
6. Test a handful of migrated tiny URLs in the browser to confirm they now go through sys_redirect.
7. Review the migrated redirects that are already expired (see What gets migrated) and decide whether to keep, disable or delete them.
8. Repeat for every storage PID that contains tiny URL records.
9. Once you are confident all relevant links have been migrated, remove this extension and drop the tx_tinyurls_urls table.

Using tinyurls in your extension 

When you want to generate tiny URLs in your own extension you can use the TxTinyurlsDomainModelTinyUrl class to set the properties and then use the TxTinyurlsTinyUrlTinyUrlGeneratorInterface service to generate the Tiny URL.

Please have a look at the PHPDoc annotations for further information. This is a quick example how to use it:

<?php

   use Tx\Tinyurls\Domain\Model\TinyUrl;
   use Tx\Tinyurls\TinyUrl\TinyUrlGeneratorInterface;

   class MyDemo
   {
       public function __construct(private TinyUrlGeneratorInterface $tinyUrlGenerator)
       {
       }

       public function createTinyUrl(string $theKey, DateTimeInterface $validUntil): string
       {
           $tinyUrl = TinyUrl::createForUrl('http://www.typo3.org');
           $tinyUrl->enableDeleteOnUse();
           $tinyUrl->setCustomUrlKey($theKey);
           $tinyUrl->setValidUntil($validUntil);

           return $this->tinyUrlGenerator->generateTinyUrl($tinyUrl);
       }
   }