EXT: PMK Forced Download¶

Table of Contents¶

EXT: PMK Forced Download 1

`Introduction 3 <#1.1.Introduction|outline>`_

What does it do? 3

`Users manual 4 <#1.2.Users%20manual|outline>`_

`Administration 5 <#1.3.Administration|outline>`_

`Configuration 6 <#1.4.Configuration|outline>`_

Reference 6

Special "register" values. 6

Examples 6

Fileicons 8

Enable pmkfdl for filelinks in tt_news 9

`Hooks for extending the plugin 10 <#1.5.Hooks%20for%20extending%20the%20plugin|outline>`_

`Known problems 11 <#1.6.Known%20problems|outline>`_

`To-Do list 12 <#1.7.To-Do%20list|outline>`_

`Reporting Bugs 13 <#1.8.Reporting%20Bugs|outline>`_

`Updates 14 <#1.9.Updates|outline>`_

`ChangeLog 15 <#1.10.ChangeLog|outline>`_

Introduction¶

Users manual¶

Once the extension is installed, you can use the new stdWrap/userFunc on your typolink file links.

Administration¶

N/A

Configuration¶

See typoscript examples later in the manual for how to use.

lib.parseFunc_RTE.tags.link.typolink.parameter.postUserFunc = tx_pmkfdl->makeDownloadLink

10 = TEXT
10.value = download
10.typolink.parameter = fileadmin/templates/images/dwarf_male120x.gif
10.typolink.parameter.makeDownloadLink = 1

10 = TEXT
10.value = download
10.typolink.parameter = fileadmin/templates/images/dwarf_male120x.gif
10.typolink.parameter.postUserFunc = tx_pmkfdl->makeDownloadLink

http://www.mydomain.com/index.php?eID=pmkfdl&file=fileadmin%2Ftemplates%2Fimages%2Fdwarf_male120x.gif&ck=a94fad5a0262b2e00e1aa72e8aac4c30

10 = TEXT
10.value = download
10.typolink.parameter = fileadmin/templates/images/dwarf_male120x.gif
10.typolink.parameter.makeDownloadLink = forcedl

10 = TEXT
10.value = download
10.typolink.parameter = fileadmin/templates/images/dwarf_male120x.gif
10.typolink.parameter.postUserFunc = tx_pmkfdl->makeDownloadLink
10.typolink.parameter.postUserFunc.makeDownloadLink = forcedl

10 = COA
10 {
    # Display the filelink
    10 = TEXT
    10.value = download
    10.typolink.parameter = fileadmin/templates/images/dwarf_male120x.gif
    10.typolink.parameter.postUserFunc = tx_pmkfdl->makeDownloadLink

    # Display the filesize from register value
    20 = TEXT
    20.data = register:filesize
    20.bytes = 1
    20.wrap = <div>Filesize:&nbsp;|</div>

    # Display the filetype from register value
    30 = TEXT
    30.data = register:filetype
    30.wrap = <div>Filetype:&nbsp;|</div>
}

10 = COA
10 {

    wrap = <div>|</div>

    # First we store the link in a register value, since
    # we want to display an icon BEFORE the link.
    10 = LOAD_REGISTER
    10.filelink.cObject = TEXT
    10.filelink.cObject {
        value = download stdWrap
        typolink.parameter = fileadmin/templates/images/dwarf_male120x.gif
        typolink.parameter.makeDownloadLink = 1
    }

    # Display the fileicon and filelink
    20 = CASE
    20 {
        # Wrapping of image, incl. the filelink from previously created register value
        stdWrap.dataWrap = | {register:filelink}

        # Case key is the filetype (from register value)
        key.data = register:filetype

        default = IMAGE
        default.file = fileadmin/fileicons/default.gif

        gif < .default
        gif.file = fileadmin/fileicons/gif.gif
        # You can add more types here
    }

    # Display the filesize ( from register value)
    30 = TEXT
    30.data = register:filesize
    30.bytes = 1
    30.wrap = &nbsp;(|)
}

http://www.mydomain.com/index.php?eID=pmkfdl&sfile=qrjyPtFoTa6AdvdexSe%2BUQekt5gkrV3ptMnhp1bzkl%2FUmI1MSdIZcYo8MDBuuy5%2BYICkJboTVh%2FcpIpdb%2BJ4UBB3upcnEShGJzNBBQl1UknUwtUg9Ifi2t4rW69cNak1tjtlGhjkkno%3D

10 = TEXT
10.value = download
10.typolink.parameter = fileadmin/templates/images/dwarf_male120x.gif
10.typolink.parameter.postUserFunc = tx_pmkfdl->makeDownloadLink
10.typolink.parameter.postUserFunc.makeDownloadLink = secure

lib.mylink < lib.downloadLink
# Specify the title of the link here.
lib.mylink.10.filelink.cObject.value = Download manual
# Specify the file for the link here.
lib.mylink.10.filelink.cObject.typolink.parameter = fileadmin/user_upload/manual.pdf

Hooks for extending the plugin¶

The extension contains two hooks for extending the functionality of the plugin:

preProcessHook (located in the file class.tx_pmkfdl.php )

This hook is activated just before the link is generated.

Possible use:

Adding extra GET parameters to the link.

Modifying the existing GET parameters.

Adding extra register values with additional data. (Such as download count.)

postProcessHook (located in the file class.tx_pmkfdl_download.php )

This hook is activated just before the file is pushed to the browser.

Possible use:

Logging the downloads. (see example hook script)

Adding additional access checks.

An example hook script class.tx_pmkfdl_process_hook.php is located in the res/ folder.

This script will create a logfile in the fileadmin/ called pmkfdl_log.txt , which is updated whenever someone downloads a file.

Known problems¶

• Due to a (still unfixed) bug in interface.tslib_content_stdwraphook.php (See Bugtracker http://bugs.typo3.org/view.php?id=9058 ), it is recommended to use the extension as a userFunc until this bug is fixed!
• The bug still exists 1.5 years after reporting it, so I guess bugfixing is not high on the TYPO3 core members priority list :(

To-Do list¶

Nothing planned, but ideas are welcome.

Reporting Bugs¶

• If you discover a bug, please don't write the author(s) directly. Instead post a bug report at the Forge bugtracker: http://forge.typo3.org/projects/show/extension-pmkfdl
• That way others can see your bug report and maybe add additional comment. It also makes it possible for all the extension authors to see what bugs are already been fixed by one of the other authors.

Updates¶

• If you like this extension, please rate it. http://typo3.org/extensions/repository/view/pmkfdl/current/rating/
• As ratings are the only way I can see if there's an interest in this extension, updates depends on people rating it.
• (No ratings = No updates)
• For latest version, always check the Forge repository: http://forge.typo3.org/projects/show/extension-pmkfdl

ChangeLog¶

• 14.Nov.2009
• Fixed problem with Access check not used in class tx_pmkfdl_download. (Thanks to Rainer Becker for reporting this.)
• TypoScript conf var is now saved as a class var, so that it can be accessed from hooks.
• 1.Nov.2009
• Added tt_news hook script to enable pmkfdl for filelinks in tt_news
• 19.Oct.2009
• Fixed linefeed problem in logfile (Thanks to Stefan Galinski for reporting this.)
• Added support for user definable logfile name/path.
• 18.Oct.2009
• Updated the manual with info about hooks and the secure mode.
• Added static template with lib object for creating filelinks with icons and filesize, similar to the one described in the manual, but using the file icons in the res/ folder.
• Fixed small problem in ext_emconf.php
• 15.Oct.2009
• Added hooks for pre- and post- processing of links. An example hooks script is located in the res/ folder. This script will create a logfile in fileadmin/ called pmkfdl_log.txt, which is updated whenever someone downloads a file.
• 14.Oct.2009
• Replaced the “crypt_blowfish” dependencies with plain PHP “mcrypt” functions.
• 7.Oct.2009
• Added support for encrypted filenames if the extension “crypt_blowfish” is installed.
• 30.Sep.2009
• Added fileicons from the Splitbrain Fileicon Project ( http://www.splitbrain.org/projects/file_icons )
• 29.Sep.2009
• Added register values for making the filesize and filetype accessible from typoscript.
• 26.Sep.2009
• Fixed Bug #4768 by adding “PATH_site” to the “finfo_file” and “mime_content_type” lookups. (Thanks to Stefan Galinski for reporting this bug.)
• Added check for blocked file extensions in the “class.tx_pmkfdl.php” file.
• 20.Sep.2009
• First version released on TER

15