NWE Package Viewer v0.5a

[MrDJK]

NOTICE: This is 'copy' of a thread posted elsewhere, if there is inconsistencies between BBCode parsers, I shall fix in a timely manner.
Original:
Okay, so sometimes I wanna check out the latest module AB releases, but don't really want to load up a copy of NWE (either locally or not), so I created this little tool.

It allows you to view the code from a NWP file, with a few other additions.


- Note: It doesn't store the files for long, just enough to allow the reading and spitting out.
- 2nd Note: AB knows about it, and suggested to post the link here, so I'm calling that, him allowing this.


Linkage

Please post suggestions/bugs/etc here if you can, Thanks.

Navigation: Lists files you can view.
Sidebar: Potential to have 4 areas:
- 1st (Top): Lists mod info, if applicable. This info comes directly from the config.xml file.
- 2nd: Lists any images that comes with it.
- 3rd: Lists any directories that are created within the mods/modname/ directory upon installation.
- 4th: List any files, the system currently doesn't know what to do with. ( I intend on logging these types of files, for future updates, though I don't do that yet, and would have to clear it with AB ).

Changelog:

Code: Select all

Changelog:
  
  - V:0.1 (14 - 01 - 2013) [released]:
      - Official release;
      - View package files.
      - List directories created on installation.
      - List images that are created on installtion.
      - List any other files the system did not know what to do with (example installed marker file).

  - V:0.2 (15 - 01 - 2013) [released]:
    - Style fixes, due to some things not behaving as expected.
    - Implementation of module version checking with the current version in the marketplace.

  - V:0.2b (15 - 01 - 2013) [released]:
    - Implemented the same features for template packages and theme packages.

  - V:0.2c ( 15 - 01 - 2013) [released]:
      - Upped the size of package limit to 50mb.

  - V:0.2d (15 - 01 - 2013) [released]:
      - Fixed a small issue with the theme files SQL being sorted under other unknown files.
      - Removed version checking from anything other than modules (may return for fonts/templates).
      - Additional: UI changes upon different types of packages: Ala: "Module Info", "Fonts Info" so on and so forth.

  - V:0.3pre (19 - 01 - 2013) [pre release]:
      -Image generation for font packages and module packages that have default images.
      -Font preview when uploading font packages.

 - V:0.4pre ( 18 - 02 - 2013 ) [ pre release to v1 ]:
   - Redesign, it has a little more colour to it now.   
   - Minor changes behind the scenes to the code, hopefully it's a little more efficient now, though it wasn't that bad to begin with, it's made it easier for the next part in the changelog.
   - It's somewhat responsive/adaptive. [Go ahead resize your browser]
      -- It works on mobile somewhat okay, providing your device's browser supports file upload ( and not a flakey implementation like Nokia/Blackberry usually do with native browsers )
   - Additional information added.
      -- User Variables.
      -- Config Keys.
   - Image listing has changed ( up down are present until I create images, but use those two to slide the image listing up and down, solves the huge list of images.
   - Addition of 'file hints/descriptions' - as per the wiki, these little descriptions will appear below the code area on files that have a description available.

Updates #1( preserved for posterity ):

Update: V:0.3 pre1;

- Image generation for font packages and module packages that have default images. ( click the image name in the image module info box, and it'll show )
- Font preview when uploading font packages ( it'll read "example" in the font files).

It's a pre-release version due to it's flaky-ness.
-Not sure if the font preview image will be reliable, especially with large font letters (average is around 70x70).
-Lightbox is a hack-together implementation by me, it'll move to a proper lightbox solution before v0.3 is out of pre-release.

The pre-release is live to test it out, and see if it's stable, so I'd appreciate it if you can report the bugs to me here.

After this release the plan is to be finished with the tool, I'll continue to maintain and update as the engine does and as bugs crop up, however as far as new features go, I cannot think of anything that will provide more use out of the tool.

Suggestions always welcome.

#plan on removing these posts of mine, and implementing a changelog in the first post.

Edit:
Posts removed, changelog added. - This post remains until out of pre.

Updates #2( preserved for posterity ):
Version 0.4 pre release is live.

Please note this is a pre release version, for testing purposes.

The change log for this version has been appended to the change log in the first post.

Main changes: Redesign, it has a little more colour to it this time around, additional information such as file descriptions ( taken from the wiki with permission ), user variables, config variables, have been added.

Note: The file descriptions aren't complete there is a lot of missing descriptions for plainly obvious files ( such as lib.php ) I'll get around to adding descriptions for these asap.

- DJK.


Bug ( and one I probably won't fix ): lightbox is a bit flaky on mobile devices, you may have to scroll back to the top when previewing an image (may hotfix auto-scroll ).

[a_bertrand]

it's really a nice addition Nice work DJK
And of course I allows it!

[MrDJK]

Thanks again.

Of course v5 will be out shortly, with the autoloaded packages from the free engine & free modules form the community that let me add theirs to the list.

[MrDJK]

Version 0.5a has been uploaded in place of the .4rc. #title updated.

This version, supports the auto loading of certain packages, therefore eliminating the need to download the package first to examine the module.
Available packages, are those that are freely available in the free version of the engine, and free modules that the authors give permission to be placed in the list.

It features a new design, I'm not much of a designer, so there will be bugs with the design and inconsistencies, which I will do my best to fix in a timely manner.
Mobile compatibility was lost in this version, the design breaks a lot ( it's somewhat useable in landscape ), and some phones will not handle the uploading of packages ( hello iPhone ), or the js used ( if it's an older model ). As a result of this, I did not bother to implement any kind of mobile-first design.

It supports, viewer only related configs, in the form of a package.json file, however after some talks with Alain, this may become redundant which is why I'm not documenting the feature.
If you wish to make use of this feature however, there is a few options you can supply:

• authorURL: Speaks for itself, it will link to the author's website as specified, where "author" is used.
• avatar: A path to an image within the package ( eg: /images/avatar.png ), this is used as almost screenshot type preview image, on the package info page.
• You can overwrite a couple of the configs within config.xml using this, ala: description, version, author ( name only ).
• versionCheckUrl: This will be used as an alternative version check, if x package is not actually on the marketplace. ( partially implemented )
• versionUpdateUrl: This will be used as an alternative update url, if x package is not actually on the marketplace. ( partially implemented )

Checking of module version in this version of the viewer is currently disabled until the above config feature is decided upon, however the default method is the same as the way the engine actually checks against versions, the alternative is undecided, however will probably end up being a simple cURL, and using the value returned as the version. Unless a better way is decided on.

Unsure on IR's linking policy, however I have changed the "NWE Community support" from a certain forum, to this one ( linked directly to the NWE subsection ).
Also I have linked directly to this thread, as a way to post bugs that may be encountered.
If this is against policy, I shall remove as requested.


NWE Package Viewer v0.5a

*ps: Sorry for the double post.

[a_bertrand]

Nice improvements! Thanks Djk!

[MrDJK]

Thanks, it's been sat locally for a week or two now, so I figured I'd put it live, so other people can potentially find bugs; Makes my life easier that's for sure.

But hey, it only took what 3-5 months, from when I first mentioned the auto loading idea to you, to get it done... Not bad lol.

[a_bertrand]

Better a bit slower than never and we both know enough examples of things which never came!

[MrDJK]

Better a bit slower than never and we both know enough examples of things which never came!

Heh, indeed.
I'm running out of ideas again for this mini-project, so even though I said this last time, this might be the last incarnation of it, from here on out just bug fixes and such.