Version control
Hosting of binary and source code downloads over a distributed network of mirrors
Support forums
Issue tracker
Mailing lists
Wiki

The latest development is that the current owners of SourceForge, DHI Group (the former Dice Holdings, which had acquired SourceForge from GeekNet in 2012), is looking to sell off its Slashdot Media assets, which includes SourceForge. It’s too early to really tell what this means for its future, but nevertheless, I’m keeping an eye out for alternatives, and if SourceForge should cease to be an option for one reason or the other, I will be forced to move elsewhere—even considering self-hosting everything I need if I really can’t avoid it.

I’ve never partaken, nor plan to partake, in the controversial opt-in DevShare program that’s been available since 2013 (which would, at the choice of a developer, bundle open source software with closed source ad-ware, and share ad revenues with developers). I’ve observed, with dismay, the project hijackings done by SourceForge of „abandoned“ projects (which weren’t really abandoned, but just weren’t using SourceForge anymore, i.e. development, file hosting etc. continued elsewhere)—thankfully, SourceForge seems to have stopped this practice, but a bad aftertaste remains. I’ve lived with my concerns about the proliferation of sometimes misleading ads on project download pages that was going on for a while, where an ad could consist of only a big green „download“ button, with no clear indication that it actually was an ad and not a download button for the project files (although the situation seems to have gotten better, and I’ve not run into any of those ads for a while now). I understand that Sourceforge needs to pay its bills somehow, but ads have in my opinion been placed and potentially picked strategically in such a way to make it more likely that visitors click them accidentally, or are mislead into clicking them.

Despite my concerns and in some cases disdain for some of the business practices employed by SourceForge, I still feel it provides me with valuable services that aren’t easily replaced (recent service outages notwithstanding)—and by easily, I mean without me having to spend a considerable amount of time setting up alternatives. The matter of fact is that no other free or paid service provider actually seems to provide all the services I currently use (see the list above)—e.g. GitHub is viable for version control, code hosting, wiki and issue tracker, but does not provide hosting of binary downloads over a distributed network of mirrors, forums or mailing lists, which all are important components to me.

That said though, a new owner might actually bring positive change. We will see.

Der Beitrag Quo vadis, SourceForge erschien zuerst bei hoech.net.

Until then, I had used Argyll CMS occasionally from time to time (I remember first discovering it in 2005), and around 2007/2008 started to use it as a tool to explore color and learn more in-depth about ICC color management from a software development perspective (I had prior knowledge as a user of ICC color management as part of my day job at an imaging and prepress house until 2006, before I became self-employed as a web developer).

I also began to grow dissatisfied with the display calibration and profiling software I was using privately, and realized that Argyll CMS did a much better job at generating a hue neutral calibration (an aging CRT that I used back then had a significant green cast in the shadows through midtones in its uncalibrated state that Argyll CMS managed to get completely rid of). I didn’t object to using Argyll CMS from the command line, but started to write a simple graphical user interface in Python (which I already had some development experience with)—with wxPython as the GUI toolkit—that would help me explore the various options without having to remember command line switches and their effects. I had no plans to make my work public at the time, in fact I didn’t even think it would be useful to anyone (it was really, really rudimentary UI-wise).

But in the same year, Argyll CMS hit its version 1.0 milestone, and subsequently I became increasingly aware (by reading forums and mailing lists) of users actually wishing for a graphical interface. I began to wonder if I should build upon what I had and release it publicly under an open source license. So I decided on the not very creative and near unpronounceable working title that would ultimately not change to this day, and began to work on this little project in my free time. I remember an ever-increasing drive and motivation coming along with this endeavor—several other people had announced their development of GUIs for Argyll CMS, and I wanted to be among the first to present something useful. In retrospect, I feel a little silly for worrying that somebody else might beat me to the punch the way I did back then—a few others managed to release their GUIs before mine was ready, but theirs seemed even more rudimentary.

The first version of dispcalGUI, numbered 0.1b, was publicly released on August 18, 2008 and still a bit rough UI-wise, but already fully cross-platform and had a few interesting features, like the automatic detection of measurement instruments. Back then I was definitely a little proud of what I had achieved in a relatively short amount of time. I received a good amount of really positive and encouraging feedback, which I remain thankful for (and keep getting) to this day.
Since then, I continued working on the project whenever I had free time available, adding features, fixing bugs and testing, testing, testing.

Over the years, I increased my knowledge of the inner workings and structure of ICC profiles, and wrote a little parser library to that effect. I learned a lot about systems, packaging, general software development advances, and interesting color and (human) vision related topics. Through following my own internal roadmap, reacting to changes and advances in the supported platforms as well as Argyll CMS itself, and by incorporating user and developer feedback, I kept driving the project forward, even though there were occasions when I had little time to further its development.

In 2010, following users repeatedly asking for a possibility to donate money to the project, I started accepting donations to aid development expenses—beforehand I wasn’t too comfortable with the idea, because I didn’t want to pressure myself into having to work on a project where a main driving factor I felt was that I could work on it whenever I felt like it and had the time, but ultimately that turned out to be a non-issue.

Fast forward. In 2012, I finally hit version 1.0 (although that was never released in binary form, the binary release was actually 1.0.7.6—the last two numbers coincide with my birth year and the release was on my birthday). Since then, development pace has continually picked up, ultimately resulting in version 2.0 being released last year and 3.0 this year with significantly overhauled UI, following an Argyll CMS 1.7 release. This brought another change with it in the sense that I’m now actively asking for donations to compensate for time and resources spent, and because I want to support Argyll CMS itself in a more direct way (all donations received by me are currently split 50/50, after deduction of PayPal fees, with me using one half and donating the other to Argyll CMS each month), the latter being a factor that I previously didn’t give much attention to even though I probably should have (dispcalGUI isn’t really useful without Argyll CMS).

My hope is that I’ll be able to continue working on this project, interacting with users and developers, furthering and refining it as time goes by.

And finally, a few lessons learned during development that may be helpful to people looking to develop a cross-platform application using Python (this is not an exhaustive list by any stretch of the imagination, and I might come back and amend it once more things come to mind):

• Cross-platform and general Unicode support in Python 2.x is not very good. It’s easy to introduce unforeseen issues even if coding carefully (some of the potential pitfalls are mentioned in the Python Unicode HOWTO, but that’s really just the tip of the iceberg). You’ll likely run into unexpected Unicode-related problems depending on platform, when you’d expect such differences to be abstracted away by the module in question. For example this os.walk bug, or the subprocess module—the latter under Windows fails with anything not representable in 7 bit ASCII, under Linux/Mac OS X it works fine as long as the file system encoding can represent the Unicode characters. In such a case, the only solution is to restrict yourself to characters representable in the file system encoding, and hand byte strings over to problematic modules. Or exclusively develop for Python 3.x instead, where Unicode support is much better and consistent.
• Platform differences in GUI behavior can be very annoying and cause unforeseen problems. If you plan to support multiple platforms, think hard about which GUI toolkit you are going to use. If the toolkit you’re considering wraps another toolkit which is native to the respective platform, like wxPython/wxWidgets does, you are very likely to run into these platform related issues. Something like Qt seems a better choice in such a scenario.

Der Beitrag Seven years of open source development—a recap erschien zuerst bei hoech.net.

Der Beitrag Perspective erschien zuerst bei hoech.net.

Gestern hinterliess jemand einen etwas ausfallenden Beitrag im Support-Forum, der erste dieser Art überhaupt (Premiere!):

after waiting an hour the programm alerts: "no profile is set" or "couldn't open Argyll_V1.7.0/bin/dispread.exe". And this file IS there and i have set the right path to "Argyll_V1.7.0/bin"

That's very dirty! For what do i wait hours and hours? An no chance to correct anything. The measurment was futile.

There are 34 types of profiles, I can choose - NOBODY NEEDS IT! But at the end of measurement I can kiss the ass of that Programm. Why is open source always so dirty made for the users? I don't understand. Do you do programming to have a wank or to do sinfull things?

Kurze Zeit später erreichte mich folgende Mail, interessanterweise über das geschäftliche Kontaktformular auf meiner Website, nicht über die Support-Mailadresse:

Von: Andy <elgringo@...>

Hallo Florian,

nachdem ich in dem zuständigen Forum auf sourceforg einen kritischen Beitrag zu DispcalGUI gepostet habe, bin ich doch umgehend gesperrt worden. Geht das auf deine Kappe? Sowas geht ja gar nicht. Wenn eine Software nicht funktioniert, wird man das wohl noch sagen dürfen. Oder seid Ihr Open-Sourcler alle so kleine Sensibelchen? Vor allem hatte ich auf reelle Hilfe gehofft, wenn es schon keine anständige Anleitung gibt. Mein Gott, ich bin Grafiker und kein Programmierer. Woher soll ich wissen, was ich mit dämlich-kryptischen Fehlermeldungen anfangen soll? Könnt Ihr Programmierer eigentlich nicht anders? Voll nerdy oder was? Da sitzen MENSCHEN am anderen Ende und versuchen verzweifelt, die mißratene Software zu benutzen!

Von: Florian Höch
An: Andy <elgringo@...>

Hallo Andy,

Am 26.06.2015 um 19:14 schrieb hoech.net Kontaktformular:
> nachdem ich in dem zuständigen Forum auf sourceforg einen kritischen 
> Beitrag zu DispcalGUI gepostet habe, bin ich doch umgehend gesperrt 
> worden. Geht das auf deine Kappe? Sowas geht ja gar nicht.

Das war aber hoffentlich nicht dein Beitrag mit dem Spam?

> Wenn eine Software nicht funktioniert, wird man das wohl noch sagen
> dürfen.

Der Ton macht die Musik.

> Oder seid Ihr Open-Sourcler alle so kleine Sensibelchen?

Was ist ein Open-Sourcler?

Und zum Thema Sensibelchen: Für jemanden, der bei einem Problem gleich
ausfallend wird, hast du eine interessante Vorstellung von "sensibel".

> Vor allem hatte ich auf reelle Hilfe gehofft, wenn es schon keine
> anständige Anleitung gibt. Mein Gott, ich bin Grafiker und kein
> Programmierer.

Es gibt gewisse Mindeststandards in der Kommunikation, von der ich
bedingungslos erwarte, dass sie eingehalten werden. Ich bin was das
angeht übrigens in einer verdammt starken Position, denn _DU_ willst was
von mir, nicht umgekehrt...

> Woher soll ich wissen, was ich mit dämlich-kryptischen 
> Fehlermeldungen anfangen soll? Könnt Ihr Programmierer eigentlich 
> nicht anders? Voll nerdy oder was? Da sitzen MENSCHEN am anderen
> Ende und versuchen verzweifelt, die mißratene Software zu benutzen!

Wenn du dir echte Hilfe in dem Tonfall erhoffst, wünsche ich dir viel Glück.

Florian.

Von: Florian Höch
An: Andy <elgringo@...>

Eine Sache noch:

Am 26.06.2015 um 19:49 schrieb Florian Höch:
>> Woher soll ich wissen, was ich mit dämlich-kryptischen 
>> Fehlermeldungen anfangen soll? Könnt Ihr Programmierer eigentlich 
>> nicht anders? Voll nerdy oder was? Da sitzen MENSCHEN am anderen
>> Ende und versuchen verzweifelt, die mißratene Software zu benutzen!

Woher soll ich wissen, was ich mit dümmlich-beleidigenden Kommentaren
anfangen soll? Könnt ihr Grafiker eigentlich nicht anders? Voll assi
oder was? Da sitzen MENSCHEN am anderen Ende und versuchen verzweifelt,
euch trotz eurer mißratenen Manieren zu helfen!

Konnte ich mir dann doch nicht verkneifen...

Florian.

An: Florian Höch
Von: Andy <elgringo@...>

ja holt euch mal weiterhin auf eure Bastelsoftware einen runter. Grad 
wieder ne Stunde auf ein Profil gewartet, um AM SCHLUSS(!) zu erfahren, 
daß mal wieder eines der nötigen Programme nicht gestartet werden 
konnte. Wie unprofessionell ist das denn? Im übrigen will ich nichts von 
dir. Da geb ich doch lieber 100,- € für BasICColor aus. Die Jungs 
wissen, was sie tun, statt dummblind auf ihre Progger-Tastaturen 
einzuhämmern. Die Software funktioniert, ist zehnmal so schnell und 
liefert anständige Profile. Und jetzt hol deine Gummipuppe raus und 
besorgs ihr, du rattenscharfer Kellernerd.

Von: Florian Höch
An: Andy <elgringo@...>

Bitte keine Spam-Nachrichten mehr. Danke.

An: Florian Höch
Von: Andy <elgringo@...>

du wolltest dir doch grad einen auf deine "starke Position" runterholen 
- bitte nicht mit den klebrigen Fingern Mails tippen - danke.

Von: Florian Höch
An: Andy <elgringo@...>

Hmmm. Du bist noch ein bisschen jung oder? Aber ich habs mir überlegt,
deine Mails sind eigentlich ganz nett. Kannst mir gern mehr schicken.

An: Florian Höch
Von: Andy <elgringo@...>

bitte keinen weiteren Spam. Nimm Stellung zu deinem unprofessionellen 
Machwerk oder reib einfach weiter - bist ja offensichtlich immer noch 
nicht fertig.

Von: Florian Höch
An: Andy <elgringo@...>

> Da geb ich doch lieber 100,- € für BasICColor aus.

Btw, ich bin basICColor Reseller, bei mir gibts die Software 50 €
günstiger bei Interesse (149,- inkl. Squid3 Messgerät, 49,- ohne).

Von: Florian Höch
An: Andy <elgringo@...>

Vergessen zu erwähnen, ich kann/darf nur an Geschäftskunden verkaufen.
Aber Gewerbe hast du wahrscheinlich eh als Graficker, sollte also kein
Problem sein.

An: Florian Höch
Von: Andy <elgringo@...>

das passt doch: Verkäuferschnösel für die Konkurrenz. Wohl nicht so 
überzeugt vom eigenen Machwerk.

Von: Florian Höch
An: Andy <elgringo@...>

Nein, du blickst es nicht :)

Das Angebot hab ich dir nur gemacht, weil du mir nicht unbedingt als der
Hellste erscheinst, und weil ich mir ziemlich sicher bin, dass du noch
nicht volljährig bist und kein Gewerbe hast.

Wenn du also so dämlich gewesen wärst, auf das Angebot einzugehen, hätt
ich dir ein Päckchen mit ausgedrucktem Trollface als einzigem Inhalt
geschickt und mich köstlich amüsiert, so wie über den ganzen Rest
unserer "Korrespondenz" 

Btw, wie alt bist du tatsächlich? Bin nur neugierig. Ich mein, dir ist
schon klar dass du es hier mit einem fast vierzigjährigen Erwachsenen zu
tun hast? Bin mir nicht sicher, weil wie gesagt sonderlich helle
scheinst du mir nicht zu sein :)

An: Florian Höch
Von: Andy <elgringo@...>

spar dir deine Ausreden. Wenn du "erwachsen" bist, kümmer dich wie ein 
Mann darum, deine eigenen Fehler auszumerzen, anstatt hier den 
Schlauberger zu geben. Der Versuch an meine Adresse zu kommen war allzu 
durchschaubar. Also hurtig jetzt deine mißratene Software wartet auf dich...

Von: Florian Höch
An: Andy <elgringo@...>

Btw, dir ist schon klar, dass die Art und Weise, wie und was jemand
schreibt, ziemlich eindeutige Rückschlüsse auf das Alter der
betreffenden Person zulässt? Wissen deine Eltern, dass du ihr Internet
benutzt? :)

An: Florian Höch
Von: Andy <elgringo@...>

scheint ja sehr interssant für dich zu sein, mal mit einem Fachmann zu 
sprechen. Und jetzt kümmer dich um deine mißratene Schadsoftware - wird 
hier gerade deinstalliert. Profile mit Rotstich sind nicht so mein Fall...

Von: Florian Höch
An: Andy <elgringo@...>

Naja, ich brauch noch ein bisschen Material für mein Blog, und da kommt
mir sowas gerade Recht. Das wird Klasse Andy :D

> Fachmann

Fachmann? Im Pöbeln? Da hab ich aber schon weitaus besseres gesehen :D

> wird hier gerade deinstalliert

Jetzt erst?

> Profile mit Rotstich sind nicht so mein Fall...

Interessant! Darf ich fragen, wie du es trotz des angeblichen "Fehlers"
geschafft hast, ein Profil zu erstellen? 

(Abgesehen von der Enttäuschung, die du erleben wirst, wenn du
feststellst, dass der Rotstich am Messgerät liegt und nicht an der
Software. Lass mich raten, du hast einen älteren Spyder oder einen ColorHug)

An: Florian Höch
Von: Andy <elgringo@...>

falsch geraten - und jetzt geh, dir einen runterholen. Darin bist du 
besser als in Farbmanagement. Sogar die Spydersoftware erstellt 
neutralere Profile als dein Bastelprogramm...

Der Beitrag Von Gringos und Gummipuppen erschien zuerst bei hoech.net.

// Make a request to ourself to figure out if this returns a 404,
// and if that is the case, show our custom 404 page
$.ajax(document.location.href, {type: 'HEAD'}).fail(function (jqXHR, textStatus, errorThrown) {
	if (jqXHR.status == 404)
		location.href = document.location.protocol + '//' + document.domain + '/not-found';
});

This still has the problem that it will briefly show the error page in the blog’s normal layout before the redirection occurs, also if the user navigates back they will end up being redirected again (this could be solved by using location.replace).

Here you can see the solution in action.

Der Beitrag Custom tumblr 404 error page erschien zuerst bei hoech.net.

Show related posts on tumblr permalink pages.
Prerequisites: jQuery.

Usage

<script>
    $(container).relatedposts(options);
</script>

container should be a valid jQuery selector. options should be an object with key/value pairs.

Possible options

domain: Your tumblr domain name e.g. mytumblr.tumblr.com. Defaults to current document domain.
num: Max. number of related posts to display.
len: Excerpt text length (number of characters).
thumbwidth: Preferred thumbnail width in px (height will scale accordingly).
tags: Array of post tags to search for.
type: Limit posts to type. Empty string (“) for all types.
titlehtml: HTML for the title tag (will be inserted before the container).

The only required option is the tags option, which should be an array of post tags.

Minimal example

Assuming you have a container with ID related in which you want to display, insert this just before the closing </body> of your theme (change your domain/path accordingly, and leave jQuery out if it is already included on the page):

{block:PermalinkPage}
    <script src="//ajax.googleapis.com/ajax/libs/jquery/1.10.2/jquery.min.js">
    </script>
    {block:Posts}
        {block:HasTags}
            <script src="//yourdomain.com/js/related.js"></script>
            <script>
                $('#related').relatedposts(
                    {tags: [{block:Tags}'{Tag}',{/block:Tags}]});
            </script>
        {/block:HasTags}
    {/block:Posts}
{/block:PermalinkPage}

You could also pull the tags via jQuery (in the example assuming post tags are displayed as links in a container with the class tags):

{block:PermalinkPage}
    <script src="//ajax.googleapis.com/ajax/libs/jquery/1.10.2/jquery.min.js">
    </script>
    {block:Posts}
        {block:HasTags}
            <script src="//yourdomain.com/js/related.js"></script>
            <script>
                $('#related').relatedposts(
                    {tags: $('.tags a').map(function() {
                               return $(this).text().replace(/^#/, '');
                           }).get()});
            </script>
        {/block:HasTags}
    {/block:Posts}
{/block:PermalinkPage}

Der Beitrag Show related posts on tumblr permalink pages erschien zuerst bei hoech.net.

Es gibt viele Möglichkeiten, die Performance einer Website zu verbessern. Neben der Optimierung von Bildern, HTML, JavaScripts und StyleSheets sowie Kompression ist sowohl browser- wie auch serverseitiges Caching (das Vorhalten von Daten in einem Zwischenspeicher) eine gute Option.

Auf dieser Website setze ich eine modifizierte Version des Hyper Cache Plug-Ins für WordPress ein. Für WordPress gibt es mehr als ein dutzend Caching-Plug-Ins, ich habe mich für dieses aufgrund seiner Einfachheit (es macht, was es soll, und nicht mehr) sowie der gefühlt guten Performance entschieden.

Ein paar kleinere und größere Kritikpunkte des Original-Plug-Ins (Version 2.8.9) gab es allerdings schon, die mich dazu veranlasst haben, das Plug-In leicht zu überarbeiten:

• Das Browser-Caching wurde durch das Setzen von entsprechenden HTTP-Antwort-Headern deaktiviert. Meiner Meinung nach ein großes No-No. Eine bessere Option besteht darin, die maximale Browser-Cache-Verweildauer anhand der Differenz der in den Optionen des Plug-Ins festgelegten Ablaufzeitspanne und des Alters der serverseitig gecachten Datei festzulegen.
• Bei Aktivierung der Kompression im Plug-in wurde nach der ersten Anfrage an eine Seite diese unkomprimiert ausgeliefert. Verschmerzbar, aber auch leicht zu ändern.
• Der Last-Modified HTTP-Antwort-Header fehlte trotz Aktivierung in den Plug-In-Optionen bei jedem ersten ungecachten Seitenzugriff.
• Und noch eine Kleinigkeit, die „304 Not Modified“ HTTP-Antwort sollte idealerweise so früh wie möglich im Code erfolgen, um nicht serverseitig unnötig Daten zu verarbeiten, die dann gar nicht gebraucht werden.

Zu guter Letzt hier die Code-Änderungen, welche die obigen Kritikpunkte beseitigen, im diff-Format gegen 2.8.9:

--- cache-2.8.9.php	Mon Apr 02 17:33:19 2012
+++ cache.php	Mon May 21 18:08:21 2012
@@ -91,6 +91,15 @@
     return;
 }

+if (array_key_exists("HTTP_IF_MODIFIED_SINCE", $_SERVER)) {
+    $if_modified_since = strtotime(preg_replace('/;.*$/', '', $_SERVER["HTTP_IF_MODIFIED_SINCE"]));
+    if ($if_modified_since >= $hc_file_time) {
+        header("HTTP/1.0 304 Not Modified");
+        flush();
+        die();
+    }
+}
+
 // Load it and check is it's still valid
 $hyper_data = @unserialize(file_get_contents($hc_file));

@@ -117,21 +126,12 @@
 }

 // It's time to serve the cached page
-if (array_key_exists("HTTP_IF_MODIFIED_SINCE", $_SERVER)) {
-    $if_modified_since = strtotime(preg_replace('/;.*$/', '', $_SERVER["HTTP_IF_MODIFIED_SINCE"]));
-    if ($if_modified_since >= $hc_file_time) {
-        header("HTTP/1.0 304 Not Modified");
-        flush();
-        die();
-    }
-}

-// Now serve the real content
+$maxage = $hyper_cache_timeout - $hc_file_age;
+header('Cache-Control: max-age=' . $maxage);
+header('Expires: ' . gmdate("D, d M Y H:i:s", time() + $maxage) . " GMT");

 // True if user ask to NOT send Last-Modified
-header('Cache-Control: no-cache, must-revalidate, max-age=0');
-header('Pragma: no-cache');
-header('Expires: Wed, 11 Jan 1984 05:00:00 GMT');
 if (!$hyper_cache_lastmodified) {
     header('Last-Modified: ' . gmdate("D, d M Y H:i:s", $hc_file_time). " GMT");
 }
@@ -195,7 +195,7 @@
     if ($hyper_redirect) {
         if ($hyper_cache_redirects) {
             $data['location'] = $hyper_redirect;
-            hyper_cache_write($data);
+            $buffer = hyper_cache_write($data);
         }
         return $buffer;
     }
@@ -233,13 +233,13 @@

     if (is_404()) $data['status'] = 404;

-    hyper_cache_write($data);
+    $buffer = hyper_cache_write($data);

     return $buffer;
 }

 function hyper_cache_write(&$data) {
-    global $hc_file, $hyper_cache_store_compressed;
+    global $hc_file, $hyper_cache_lastmodified, $hyper_cache_store_compressed, $hyper_cache_timeout;

     $data['uri'] = $_SERVER['REQUEST_URI'];

@@ -247,12 +247,21 @@
     if ($hyper_cache_store_compressed) {
         $data['gz'] = gzencode($data['html']);
         if ($data['gz']) unset($data['html']);
+        header('Content-Encoding: gzip');
     }
     $file = fopen($hc_file, 'w');
     fwrite($file, serialize($data));
     fclose($file);

-    header('Last-Modified: ' . date("r", @filemtime($hc_file)));
+    header('Cache-Control: max-age=' . $hyper_cache_timeout);
+    header('Expires: ' . gmdate("D, d M Y H:i:s", time() + $hyper_cache_timeout) . " GMT");
+
+    // True if user ask to NOT send Last-Modified
+    if (!$hyper_cache_lastmodified) {
+        header('Last-Modified: ' . gmdate("D, d M Y H:i:s", @filemtime($hc_file)). " GMT");
+    }
+
+    return !empty($data['gz']) ? $data['gz'] : $data['html'];
 }

 function hyper_mobile_type() {

Dieser Beitrag wurde unter Creative Commons Namensnennung-Nicht-kommerziell-Weitergabe unter gleichen Bedingungen 3.0 Deutschland Lizenz veröffentlicht.

Der Beitrag Caching in WordPress erschien zuerst bei hoech.net.

Zur deutschen Version dieses Artikels

To conserve bandwidth and speed up page loading, it pays off to also compress static files like stylesheets and scripts in addition to the page itself with GZIP and set meaningful cache retention times. With Apache, this process can be set up with a custom .htaccess file as dynamic on-the-fly compression with either mod_deflate, or alernatively via PHP. In my case I settled with a PHP solution which stores the compressed data on disk, so repeated requests don’t cause the files to be compressed over and over again, but only on first access (or if the file has changed).

The PHP script which takes care of the compression of requested files and stores the compressed data as .gz files on disk looks like this:

<?php

function get_content_type($file) {
    // Determine Content-Type based on file extension
    // Default to text/html
    $info = pathinfo($file);
    $content_types = array('css' => 'text/css; charset=UTF-8',
                           'html' => 'text/html; charset=UTF-8',
                           'gif' => 'image/gif',
                           'ico' => 'image/x-icon',
                           'jpg' => 'image/jpeg',
                           'jpeg' => 'image/jpeg',
                           'js' => 'application/javascript',
                           'json' => 'application/json',
                           'png' => 'image/png',
                           'txt' => 'text/plain',
                           'xml' => 'application/xml');
    if (empty($content_types[$info['extension']]))
        return 'text/html; charset=UTF-8';
    return $content_types[$info['extension']];
}

function main() {
    // Get file path by stripping query parameters from the request URI
    if (!empty($_SERVER['REQUEST_URI']))
        $path = preg_replace('/\/?(?:\?.*)?$/', '', $_SERVER['REQUEST_URI']);

    // If the path is empty, either use DEFAULT_FILENAME if defined, or exit
    if (empty($path)) {
        if (defined('DEFAULT_FILENAME')) $path = '/' . DEFAULT_FILENAME;
        else die();
    }

    $file = dirname(__FILE__) . $path;
    if (!file_exists($file)) die();

    $mtime = filemtime($file);

    // If the user agent sent a IF_MODIFIED_SINCE header, check if the file
    // has been modified. If it hasn't, send '304 Not Modified' header & exit
    if (!empty($_SERVER['HTTP_IF_MODIFIED_SINCE']) &&
        $mtime <= strtotime($_SERVER['HTTP_IF_MODIFIED_SINCE'])) {
        header($_SERVER['SERVER_PROTOCOL'] . ' 304 Not Modified', true, 304);
        exit;
    }
    
    // Determine Content-Type based on file extension
    $content_type = get_content_type($file);

    // If the user agent accepts GZIP encoding, store a compressed version of
    // the file (<filename>.gz)
    if (!empty($_SERVER['HTTP_ACCEPT_ENCODING']) &&
        in_array('gzip', preg_split('/\s*,\s*/',
                                    $_SERVER['HTTP_ACCEPT_ENCODING']))) {
        // Only write the compressed version if it does not yet exist or the
        // original file has changed
        $gzfile = $file . '.gz';
        if (!file_exists($gzfile) || filemtime($gzfile) < $mtime)
            file_put_contents($gzfile, gzencode(file_get_contents($file)));
        // Send compression headers and use the .gz file instead of the
        // original filename
        header('Content-Encoding: gzip');
        $file = $file . '.gz';
    }

    // Vary max-age and expiration headers based on content type
    switch ($content_type) {
        case 'image/gif':
        case 'image/jpeg':
        case 'image/png':
            // Max-age for images: 31 days
            $maxage = 60 * 60 * 24 * 31;
            break;
        default:
            // Max-age for everything else: 7 days
            $maxage = 60 * 60 * 24 * 7;
    }

    // Send remaining headers
    header('Vary: Accept-Encoding');
    header('Cache-Control: max-age=' . $maxage);
    header('Expires: ' . gmdate('D, d M Y H:i:s', time() + $maxage) . ' GMT');
    header('Last-Modified: ' . gmdate('D, d M Y H:i:s', $mtime) . ' GMT');
    header('Content-Type: ' . $content_type);
    header('Content-Length: ' . filesize($file));
    
    // If the request method isn't HEAD, send the file contents
    if ($_SERVER['REQUEST_METHOD'] != 'HEAD') readfile($file);
}

main();

?>

The script is stored as ‚gz.php‘ inside of the root directory of my WordPress installation. It detects if files have changed and recompresses them if needed. In addition it sends a ‚304 Not Modified‘ header if a file hasn’t changed since it was last requested. Furthermore we need to adjust the  .htaccess file. For my own WordPress installation it looks like this:

# Set 'Vary' response header for .gz files
<FilesMatch "\.gz$">
<IfModule mod_headers.c>
Header always append Vary "Accept-Encoding"
</IfModule>
</FilesMatch>

<IfModule mod_expires.c>
ExpiresActive On
ExpiresByType application/json "access plus 1 week"
ExpiresByType application/x-javascript "access plus 1 week"
ExpiresByType application/xml "access plus 1 week"
ExpiresByType image/gif "access plus 1 month"
ExpiresByType image/jpeg "access plus 1 month"
ExpiresByType image/png "access plus 1 month"
ExpiresByType image/x-icon "access plus 1 month"
ExpiresByType text/css "access plus 1 week"
ExpiresByType text/html "access plus 1 week"
ExpiresByType text/plain "access plus 1 week"
</IfModule>

# BEGIN WordPress
<IfModule mod_rewrite.c>
RewriteEngine On
RewriteBase /
RewriteRule ^index\.php$ - [L]
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule . /index.php [L]
</IfModule>
# END WordPress

# BEGIN GZIP
<IfModule mod_rewrite.c>
# If the user agent accepts gzip encoding...
RewriteCond %{HTTP:Accept-Encoding} gzip
# ...and the requested file exists...
RewriteCond %{REQUEST_FILENAME} -f
# ...then use a PHP script serve a compressed version. Done.
RewriteRule \.(css|html|ico|js|json|txt|xml)$ /gz.php [L]
</IfModule>
# END GZIP

For .gz file access, a ‚Vary‘ header is sent to enable correct caching over proxies. Following this directive are several directives for cache retention times (‚Expires‘ and ‚Cache Control‘ header, users may change those as it suits them. In my case, CSS and JS files expire after one week and images after one month.

Alternatively, the mod_rewrite rule for the PHP script can be changed so only the first request calls upon the script, and subsequently the .gz files are accessed directly (which has the drawback that you need to remember to delete any .gz files manually if you make changes, but doesn’t need to call PHP for each file access):

<IfModule mod_rewrite.c>
# If the user agent accepts gzip encoding...
RewriteCond %{HTTP:Accept-Encoding} gzip
# ...and if gzip-encoded version of the requested file exists (<file>.gz)...
RewriteCond %{REQUEST_FILENAME}.gz -f
# ...then serve the gzip-encoded file. Done.
RewriteRule ^(.+)$ $1.gz [L]
# Or if the user agent accepts gzip encoding...
RewriteCond %{HTTP:Accept-Encoding} gzip
# ...and the requested file exists...
RewriteCond %{REQUEST_FILENAME} -f
# ...then use a PHP script serve a compressed version. Done.
RewriteRule \.(css|html|ico|js|json|txt|xml)$ /gz.php [L]
</IfModule>

Credits: .gz-Icon based on generic package icon from GNOME 2.18 Icon Theme, released under GNU GPL 2.0 Lizenz

This article was published under Attribution-NonCommercial-ShareAlike 3.0 Unported (CC BY-NC-SA 3.0).

Der Beitrag GZIP compression of static assets via mod_rewrite and PHP erschien zuerst bei hoech.net.

View english version of this article

Um Bandbreite zu sparen und die Downloadgeschwindigkeit zu erhöhen, lohnt es sich, auch statische Dateien wie Stylesheets und JavaScripts mit GZIP zu komprimieren und eine sinnvolle Cache-Verweildauer festzulegen. Das lässt sich mit einer angepassten .htacces-Datei gut automatisieren. Hierbei kann man entweder auf die dynamische Kompression mittels Apache mod_deflate oder aber eine Alternativlösung (in diesem Fall ein PHP-Skript) zurückgreifen. Ich habe mich für die PHP-Lösung entschieden, da ich die komprimierten Daten so im Dateisystem ablegen kann und etwas Prozessorleistung für die dynamische Kompression spare, die sonst mit mod_deflate bei jedem Dateizugriff erfolgt (und nicht nur beim ersten oder bei Änderungen, was den Vorteil der PHP-Lösung ausmacht).

Das PHP-Skript, das sich um die Kompression der angefragten Dateien kümmert und sie als statische .gz-Dateien auf dem Server ablegt, sieht wie folgt aus:

<?php

function get_content_type($file) {
    // Determine Content-Type based on file extension
    // Default to text/html
    $info = pathinfo($file);
    $content_types = array('css' => 'text/css; charset=UTF-8',
                           'html' => 'text/html; charset=UTF-8',
                           'gif' => 'image/gif',
                           'ico' => 'image/x-icon',
                           'jpg' => 'image/jpeg',
                           'jpeg' => 'image/jpeg',
                           'js' => 'application/javascript',
                           'json' => 'application/json',
                           'png' => 'image/png',
                           'txt' => 'text/plain',
                           'xml' => 'application/xml');
    if (empty($content_types[$info['extension']]))
        return 'text/html; charset=UTF-8';
    return $content_types[$info['extension']];
}

function main() {
    // Get file path by stripping query parameters from the request URI
    if (!empty($_SERVER['REQUEST_URI']))
        $path = preg_replace('/\/?(?:\?.*)?$/', '', $_SERVER['REQUEST_URI']);

    // If the path is empty, either use DEFAULT_FILENAME if defined, or exit
    if (empty($path)) {
        if (defined('DEFAULT_FILENAME')) $path = '/' . DEFAULT_FILENAME;
        else die();
    }

    $file = dirname(__FILE__) . $path;
    if (!file_exists($file)) die();

    $mtime = filemtime($file);

    // If the user agent sent a IF_MODIFIED_SINCE header, check if the file
    // has been modified. If it hasn't, send '304 Not Modified' header & exit
    if (!empty($_SERVER['HTTP_IF_MODIFIED_SINCE']) &&
        $mtime <= strtotime($_SERVER['HTTP_IF_MODIFIED_SINCE'])) {
        header($_SERVER['SERVER_PROTOCOL'] . ' 304 Not Modified', true, 304);
        exit;
    }
    
    // Determine Content-Type based on file extension
    $content_type = get_content_type($file);

    // If the user agent accepts GZIP encoding, store a compressed version of
    // the file (<filename>.gz)
    if (!empty($_SERVER['HTTP_ACCEPT_ENCODING']) &&
        in_array('gzip', preg_split('/\s*,\s*/',
                                    $_SERVER['HTTP_ACCEPT_ENCODING']))) {
        // Only write the compressed version if it does not yet exist or the
        // original file has changed
        $gzfile = $file . '.gz';
        if (!file_exists($gzfile) || filemtime($gzfile) < $mtime)
            file_put_contents($gzfile, gzencode(file_get_contents($file)));
        // Send compression headers and use the .gz file instead of the
        // original filename
        header('Content-Encoding: gzip');
        $file = $file . '.gz';
    }

    // Vary max-age and expiration headers based on content type
    switch ($content_type) {
        case 'image/gif':
        case 'image/jpeg':
        case 'image/png':
            // Max-age for images: 31 days
            $maxage = 60 * 60 * 24 * 31;
            break;
        default:
            // Max-age for everything else: 7 days
            $maxage = 60 * 60 * 24 * 7;
    }

    // Send remaining headers
    header('Vary: Accept-Encoding');
    header('Cache-Control: max-age=' . $maxage);
    header('Expires: ' . gmdate('D, d M Y H:i:s', time() + $maxage) . ' GMT');
    header('Last-Modified: ' . gmdate('D, d M Y H:i:s', $mtime) . ' GMT');
    header('Content-Type: ' . $content_type);
    header('Content-Length: ' . filesize($file));
    
    // If the request method isn't HEAD, send the file contents
    if ($_SERVER['REQUEST_METHOD'] != 'HEAD') readfile($file);
}

main();

?>

Das Skript sollte als ‚gz.php‘ im Wurzelverzeichnis der WordPress-Installation liegen. Es erkennt, wann eine Datei geändert wurde und komprimiert diese nur dann erneut. Ausserdem sendet es eine ‚304 Not Modified‘-Antwort, falls eine angefragte Datei seit der letzten Anfrage nicht verändert wurde.

Dann benötigen wir eine angepasste .htaccess-Datei. Für meine WordPress-Installation sieht diese wie folgt aus:

# Set 'Vary' response header for .gz files
<FilesMatch "\.gz$">
<IfModule mod_headers.c>
Header always append Vary "Accept-Encoding"
</IfModule>
</FilesMatch>

<IfModule mod_expires.c>
ExpiresActive On
ExpiresByType application/json "access plus 1 week"
ExpiresByType application/x-javascript "access plus 1 week"
ExpiresByType application/xml "access plus 1 week"
ExpiresByType image/gif "access plus 1 month"
ExpiresByType image/jpeg "access plus 1 month"
ExpiresByType image/png "access plus 1 month"
ExpiresByType image/x-icon "access plus 1 month"
ExpiresByType text/css "access plus 1 week"
ExpiresByType text/html "access plus 1 week"
ExpiresByType text/plain "access plus 1 week"
</IfModule>

# BEGIN WordPress
<IfModule mod_rewrite.c>
RewriteEngine On
RewriteBase /
RewriteRule ^index\.php$ - [L]
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule . /index.php [L]
</IfModule>
# END WordPress

# BEGIN GZIP
<IfModule mod_rewrite.c>
# If the user agent accepts gzip encoding...
RewriteCond %{HTTP:Accept-Encoding} gzip
# ...and the requested file exists...
RewriteCond %{REQUEST_FILENAME} -f
# ...then use a PHP script serve a compressed version. Done.
RewriteRule \.(css|html|ico|js|json|txt|xml)$ /gz.php [L]
</IfModule>
# END GZIP

Für .gz-Dateizugriffe wird der ‚Vary‘-Header festgelegt, um korrektes Caching über Proxy-Server zu gewährleisten. Dann folgen einige Direktiven zur Cache-Verweildauer (‚Expires‘- bzw. ‚Cache-Control‘-Header), diese lassen sich nach eigenem Gusto anpassen. Im Beispiel laufen CSS- und JS-Dateien nach einer Woche im Cache ab, Bilddateien nach einem Monat.

Alternativ lässt sich die mod_rewrite-Direktive für das PHP-Skript auch so ändern, dass nur der erste Zugriff einen Aufruf des Skripts erzeugt, und danach direkt die erstellte .gz-Datei abgerufen wird. Dazu die Zeilen zwischen # BEGIN GZIP und # END GZIP in dem .htaccess-Beispiel oben durch folgende Zeilen ersetzen:

<IfModule mod_rewrite.c>
# If the user agent accepts gzip encoding...
RewriteCond %{HTTP:Accept-Encoding} gzip
# ...and if gzip-encoded version of the requested file exists (<file>.gz)...
RewriteCond %{REQUEST_FILENAME}.gz -f
# ...then serve the gzip-encoded file. Done.
RewriteRule ^(.+)$ $1.gz [L]
# Or if the user agent accepts gzip encoding...
RewriteCond %{HTTP:Accept-Encoding} gzip
# ...and the requested file exists...
RewriteCond %{REQUEST_FILENAME} -f
# ...then use a PHP script serve a compressed version. Done.
RewriteRule \.(css|html|ico|js|json|txt|xml)$ /gz.php [L]
</IfModule>

Bildnachweis: .gz-Icon basierend auf generischem Paket-Icon aus GNOME 2.18 Icon Theme, veröffentlicht unter GNU GPL 2.0 Lizenz

Dieser Beitrag wurde unter Creative Commons Namensnennung-Nicht-kommerziell-Weitergabe unter gleichen Bedingungen 3.0 Deutschland Lizenz veröffentlicht.

Der Beitrag GZIP-Kompression für statische Dateien mit mod_rewrite und PHP erschien zuerst bei hoech.net.

Der Beitrag Neue Website ist online erschien zuerst bei hoech.net.