Jump to content
horst

Release: LocalAudioFiles MP3-DB

Recommended Posts

Local Audio Files - MP3-DB

The Local Audio Files DB is a combination of a Module and a SiteProfile. It is intended to import MP3-files from your filesystem into ProcessWire, read ID3-Tags and pull coverImages from it to feed the DB.
 
It is thought as a starting point for your own site creation. A sort of comfortable aggregated reuseable code for PW-lovers. :P
 

How to Install

Grab a copy of the latest ProcessWire. Replace the install, modules and templates directories with those in this profile, as shown below:

  • /site-default/install/
  • /site-default/modules/
  • /site-default/templates/

With SiteProfile-Installs normally that is all there is to do. With this Profile you also have to copy the file LocalAudioFilesImportShellScript.php (for simplicity) to your PW-rootfolder, (where the index.php reside). If you are on Windows you also should copy mp3_import_starter4win.cmd to the same location.
 
Now install ProcessWire as per the instructions included with it and it will install the LocalAudioFiles profile automatically.
 
After that you find a Quickstart Guide at the homepage of the profile:
post-1041-0-45379400-1369002668_thumb.jp
 
Follow the 3 steps and you are done!
 
 
How does it work?

  • The Site has 4 sibling Tree Branches: genres - artists - albums - songs.
  • Each of them hold child-pages: genre - artist - album - song.
  • The logical relations are nested parent-children ones: a genre hold artists, each artist hold albums, each album hold songs.
  • To support both, slim and fast data relations & the logical hirarchy, the module extends the ProcessWire variable $page with some additions. It uses the addHookProperty mechanism to achieve that.
  • It uses an own caching mechanism for large lists, that can be prebuild when running the importer-shellscript, or it build the cache on demand.
  • Also it comes with a FrontEndHandler class that provides a lot of functionality, for example fully customizable FormSelectFields of all genres, artists or albums.
  • More detailed informations and code examples are collected in a demo section of the site.

The extended $page variable together with the LocalAudioFiles-FrontEndHandler gives you comprehensive tools to work with your music collection.
 
 
Download

 
 
LiveDemo
 
I have uploaded a small LiveDemo with only 7 truncated songs. But it's pretty fine to view all Demos and the additional $page->proterties. :)

 
Graphical overview
 
post-1041-0-96922200-1369005535_thumb.pn
 
 
Screencast of installation
 
https://youtu.be/-qYyppvEF1k
 
 
History of origins
 
http://processwire.com/talk/topic/3322-how-to-setup-relations-for-a-mp3-db-with-pw/
http://processwire.com/talk/topic/3462-pages-get-return-nullpage-but-page-exists/

  • Like 9

Share this post


Link to post
Share on other sites

Well done Horst!

Sorry didn't have time to test the last version. Will make some time for this :)

  • Like 1

Share this post


Link to post
Share on other sites

A little change in the importer script has to be done:

- added a line that prevents the Shellwindow from closing when the wrong username/password was provided.

With the fix now it stays open and the user get the info.


LocalAudioFilesImportShellScript.zip  (is included in the above Version 1.0.5 now)

Edited by horst

Share this post


Link to post
Share on other sites

Awesome work Horst!

  • Like 1

Share this post


Link to post
Share on other sites

Are the mentioned Examples & Demo hosted live someplace? They don't seem to be linked to anything.

Looks awesome!

Share this post


Link to post
Share on other sites

Are the mentioned Examples & Demo hosted live someplace? They don't seem to be linked to anything.

Looks awesome!

?? uhhm, - you first have to run the ShellImporterScript, then the Examples & Demos have some 'food' to work :-) (They don't within an empty DB)

 

No sorry, there is no LiveDemo.

Share this post


Link to post
Share on other sites

Really impressed by all you've put together here Horst, nice work! 

  • Like 1

Share this post


Link to post
Share on other sites

Thanks Ryan.

It was really massive learning to write this together. In fact I have (re)written it three to four times. :P

Every time I want it to do something from what I don't know the PW-way, I have done it old-schooled first. Then a few days later, I've found informations here in Forum or in the docu that show me how to do it better. And I have rewritten it. Much work, much fun, me.better PW.coder now. ( but also much.much.much.more to learn )

The only downside with that project is that I now don't like my (before LocalAudioFiles) new created (but still not finished) portfolio site any more. :mellow:

I have trashed it and started new from scratch.

With it there are new things like sessions, redirects, cookies and, ...

yes, again: much.learning! :-)

  • Like 2

Share this post


Link to post
Share on other sites
34 minutes ago, AndréPortuga said:

Its not working on my machine. Whenever I refresh the modules page it shows me a error.

Hhm, this is a very old one, from 2013. Which version of PW do you use?

 

Share this post


Link to post
Share on other sites
20 minutes ago, horst said:

Hhm, this is a very old one, from 2013. Which version of PW do you use?

 

ProcessWire 3.0.123 © 2020; Is there another way of having a mp3 field? 

Share this post


Link to post
Share on other sites

I haven't tried out this module, but often with old modules (pre PW v.3) all you need is to add the PW namespace at the first line of the module.

i.e. https://github.com/horst-n/LocalAudioFiles/blob/master/site-default/modules/LocalAudioFiles/LocalAudioFiles.module

just replace first line with
<?php namespace ProcessWire;

then refresh modules and try again. If that doesn't work, you should post the error messages you see.

Share this post


Link to post
Share on other sites

I Just created a field using file type. In supported extensions I putted mp4 and mp3, and it worked well.

Thank you, btw...

  • Like 1

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By joshua
      This module is (yet another) way for implementing a cookie management solution.
      Of course there are several other possibilities:
      - https://processwire.com/talk/topic/22920-klaro-cookie-consent-manager/
      - https://github.com/webmanufaktur/CookieManagementBanner
      - https://github.com/johannesdachsel/cookiemonster
      - https://www.oiljs.org/
      - ... and so on ...
      In this module you can configure which kind of cookie categories you want to manage:

      You can also enable the support for respecting the Do-Not-Track (DNT) header to don't annoy users, who already decided for all their browsing experience.
      Currently there are four possible cookie groups:
      - Necessary (always enabled)
      - Statistics
      - Marketing
      - External Media
      All groups can be renamed, so feel free to use other cookie group names. I just haven't found a way to implement a "repeater like" field as configurable module field ...
      When you want to load specific scripts ( like Google Analytics, Google Maps, ...) only after the user's content to this specific category of cookies, just use the following script syntax:
      <script type="text/plain" data-type="text/javascript" data-category="statistics" data-src="/path/to/your/statistic/script.js"></script> <script type="text/plain" data-type="text/javascript" data-category="marketing" data-src="/path/to/your/mareketing/script.js"></script> <script type="text/plain" data-type="text/javascript" data-category="external_media" data-src="/path/to/your/external-media/script.js"></script> <script type="text/plain" data-type="text/javascript" data-category="marketing">console.log("Inline scripts are also working!");</script> The type has to be "optin" to get recognized by PrivacyWire, the data-attributes are giving hints, how the script shall be loaded, if the data-category is within the cookie consents of the user. These scripts are loaded asynchronously after the user made the decision.
      If you want to give the users the possibility to change their consent, you can use the following Textformatter:
      [[privacywire-choose-cookies]] It's planned to add also other Textformatters to opt-out of specific cookie groups or delete the whole consent cookie.
      You can also add a custom link to output the banner again with a link / button with following class:
      <a href="#" class="privacywire-show-options">Show Cookie Options</a> <button class="privacywire-show-options">Show Cookie Options</button> This module is still in development, but we already use it on several production websites.
      You find it here: PrivacyWire Git Repo
      Download as .zip
      I would love to hear your feedback 🙂
      CHANGELOG
      0.1.1 Debugging: fixed error during uninstall 0.1.0 Added new detection of async scripts for W3C Validation 0.0.6 CSS-Debugging for hiding unused buttons, added ProCache support for the JavaScript tag 0.0.5 Multi-language support included completely (also in TextFormatter). Added possibility to async load other assets (e.g. <img type="optin" data-category="marketing" data-src="https://via.placeholder.com/300x300">) 0.0.4 Added possibility to add an imprint link to the banner 0.0.3 Multi-language support for module config (still in development) 0.0.2 First release 0.0.1 Early development
    • By bernhard
      --- Please use RockFinder3 ---
    • By MoritzLost
      Cacheable Placeholders
      This module allows you to have pieces of dynamic content inside cached output. This aims to solve the common problem of having a mostly cacheable site, but with pieces of dynamic output here and there.  Consider this simple example, where you want to output a custom greeting to the current user:
      <h1>Good morning, <?= ucfirst($user->name) ?></h1> This snippet means you can't use the template cache (at least for logged-in users), because each user has a different name. Even if 99% of your output is static, you can only cache the pieces that you know won't include this personal greeting. A more common example would be CSRF tokens for HTML forms - those need to be unique by definition, so you can't cache the form wholesale.
      This module solves this problem by introducing cacheable placeholders - small placeholder tokens that get replaced during every request. The replacement is done inside a Page::render hook so it runs during every request, even if the response is served from the template cache. So you can use something like this:
      <h1>Good morning, {{{greeting}}}</h1> Replacement tokens are defined with a callback function that produces the appropriate output and added to the module through a simple hook:
      // site/ready.php wire()->addHookAfter('CachePlaceholders::getTokens', function (HookEvent $e) { $tokens = $e->return; $tokens['greeting'] = [ 'callback' => function (array $tokenData) { return ucfirst(wire('user')->name); } ]; $e->return = $tokens; }); Tokens can also include parameters that are parsed and passed to the callback function. There are more fully annotated examples and step-by-step instructions in the README on Github!
      Features
      A simple and fast token parser that calls the appropriate callback and runs automatically. Tokens may include multiple named or positional parameters, as well as multi-value parameters. A manual mode that allows you to replace tokens in custom pieces of cached content (useful if you're using the $cache API). Some built-in tokens for common use-cases: CSRF-Tokens, replacing values from superglobals and producing random hexadecimal strings. The token format is completely customizable, all delimiters can be changed to avoid collisions with existing tag parsers or template languages. Links
      Github Repository & documentation Module directory (pending approval) If you are interested in learning more, the README is very extensive, with more usage examples, code samples and usage instructions!
    • By Craig
      I've been using Fathom Analytics for a while now and on a growing number of sites, so thought it was about time there was a PW module for it.
      WayFathomAnalytics
      WayFathomAnalytics is a group of modules which will allow you to view your Fathom Analytics dashboard in the PW admin panel and (optionally) automatically add and configure the tracking code on front-end pages.
      Links
      GitHub Readme & documentation Download Zip Modules directory Module settings screenshot What is Fathom Analytics?
      Fathom Analytics is a simple, privacy-focused website analytics tool for bloggers and businesses.

      Stop scrolling through pages of reports and collecting gobs of personal data about your visitors, both of which you probably don't need. Fathom is a simple and private website analytics platform that lets you focus on what's important: your business.
      Privacy focused Fast-loading dashboards, all data is on a single screen Easy to get what you need, no training required Unlimited email reports Private or public dashboard sharing Cookie notices not required (it doesn't use cookies or collect personal data) Displays: top content, top referrers, top goals and more
    • By daniels
      This is a lightweight alternative to other newsletter & newsletter-subscription modules.
      You can find the Module in the Modules directory and on Github
      It can subscribe, update, unsubscribe & delete a user in a list in Mailchimp with MailChimp API 3.0. It does not provide any forms or validation, so you can feel free to use your own. To protect your users, it does not save any user data in logs or sends them to an admin.
      This module fits your needs if you...
      ...use Mailchimp as your newsletter / email-automation tool ...want to let users subscribe to your newsletter on your website ...want to use your own form, validation and messages (with or without the wire forms) ...don't want any personal user data saved in any way in your ProcessWire environment (cf. EU data regulation terms) ...like to subscribe, update, unsubscribe or delete users to/from different lists ...like the Mailchimp UI for creating / sending / reviewing email campaigns *I have only tested it with PHP 7.x so far, so use on owners risk
      EDIT:
      Since 0.0.4, instructions and changelog can be found in the README only. You can find it here  🙂
      If you have questions or like to contribute, just post a reply or create an issue or pr on github, thanks!
×
×
  • Create New...