Jump to content
fbg13

File Editor

Recommended Posts

Normally I locked down such features in any CMS I've used so far, but thanks for sharing anyway.

Share this post


Link to post
Share on other sites

Thanks for sharing @fbg13 - just so you know, we already have: http://modules.processwire.com/modules/template-editor/ and there is @tpr's fork which adds module file editing as well: https://github.com/rolandtoth/ProcessTemplateEditor

It might be worth trying to consolidate the two modules - I am not sure the feature set of yours vs @Nico Knoll's and @tpr's fork. 

I know Nico has been quiet around here of late - perhaps you or @tpr could take over with one definitive module for this?

  • Like 2

Share this post


Link to post
Share on other sites

I would be happy if it weren't me - you know, steroids side effects :)

  • Like 4

Share this post


Link to post
Share on other sites
12 hours ago, adrian said:

Thanks for sharing @fbg13 - just so you know, we already have: http://modules.processwire.com/modules/template-editor/ and there is @tpr's fork which adds module file editing as well: https://github.com/rolandtoth/ProcessTemplateEditor

It might be worth trying to consolidate the two modules - I am not sure the feature set of yours vs @Nico Knoll's and @tpr's fork. 

I know Nico has been quiet around here of late - perhaps you or @tpr could take over with one definitive module for this?

I did this mostly to learn how to create a module with settings and a PW admin page.

Maybe it would fit better in the Module/Plugin Development sub-forum.

Share this post


Link to post
Share on other sites
1 minute ago, fbg13 said:

Maybe it would fit better in the Module/Plugin Development sub-forum.

I am not saying that at all. Nico is working at an agency these days that is mostly using MeteorJS, so I don't think he has much time to maintain his modules. I just thought it might be worth contacting him and seeing if perhaps you could take over his module, or let us know what advantages yours has over his. We're just all keen on limiting the number of module duplicates that WP suffers with - certainly not trying to diminish your efforts at all - sorry if it came across that way.

I wasn't even sure if you knew about his module so it was also a bit of a heads up in that regard.

Keep up the great work!

  • Like 2

Share this post


Link to post
Share on other sites

@adrian I know what you meant.

Just that i built this to learn and don't know how much i will further improve this module, that's why maybe the  development sub-forum might have been a better fit.

Share this post


Link to post
Share on other sites
8 hours ago, fbg13 said:

@adrian I know what you meant.

Just that i built this to learn and don't know how much i will further improve this module, that's why maybe the  development sub-forum might have been a better fit.

Honestly it looks like you module might be more complete - you are using a js code editor which would make for a much nicer editing experience and it looks like your use of php file tree also makes for a better interface.

I don't think this should be hidden at all - I think I'd rather see it in the modules directory as well as Nico's, rather than being lost.

  • Like 2

Share this post


Link to post
Share on other sites

This looks awesome, well I don't think we should limited to 1 Module, different modules might have things that don't appeal to you, with that being said, This will benefit me because I am behind a Firewall at the office, so it's hard to FTP in my site. 

  • Like 1

Share this post


Link to post
Share on other sites

@fbg13

Could you make it so that the edit page is only provided to superusers and maybe users with a certain role such as 'file-editor'? This would allow people like Sephiroth to use your module while keeping other users well away from the files.

  • Like 1

Share this post


Link to post
Share on other sites

@netcarver i tested the roles and permissions and it looks like until a superuser give another role the "file-editor" permission he can't access the page at all. 

While testing this i discovered a bug,  if the edited file contains the "</textarea>" text it will cause the text-area to close prematurely causing weird output, this is caused by code mirror. Will look into it.

Share this post


Link to post
Share on other sites
2 minutes ago, fbg13 said:

i tested the roles and permissions and it looks like until a superuser give another role the "file-editor" permission he can't access the page at all. 

I think that's a reasonable position to take - it addresses the concern expressed by @szabesz here, and can still be used to provide folks like @Sephiroth access as described here.

  • Like 1

Share this post


Link to post
Share on other sites

Updated the module to fix the above bug and some other things.

Also added options to set a height for the editor, choose whether you want to include or exclude the defined extensions and the default file is now relative to the default directory.

  • Like 2

Share this post


Link to post
Share on other sites

Thanks, @fbg13It's not quit ready for prime time yet, there are some bugs I'm working on, will update here.

  • Like 1

Share this post


Link to post
Share on other sites

v1.5.0:

- warning about unsaved changes (suggested by tpr)
- better wording about include/exclude filter (suggested by tpr)
- better visual feedback on Save (suggested by tpr)
- theme selection (suggested by tpr)
- small speed improvement on directory tree generation
- small enhancements and fixes
- codemirror update to 5.20.2

Thanks to our "Man on Steroids" :-)

  • Like 3

Share this post


Link to post
Share on other sites

It seems that this *reputation* sticks with me even though I'm clean :) Nomen est omen? :)

Ontopic: this is a great module, simple and minimal, comes handy for quick modifications when there's no editor or IDE at hand.

  • Like 2

Share this post


Link to post
Share on other sites

Hi everyone,

I just installed this for the first time to help debug something on someone's site and thought this would be the easiest way to edit module files without asking for FTP access. It worked great until I saved the file with a syntax error and then needed FTP access to get anything working. This is more of a heads up than anything. Not sure what a workaround might be. Tracy's TemplateEditor Panel allows testing file changes, but this only works for the template file of the current page. Not sure how this could be done for other files - seems unlikely, but I'll have a think.

The other thing I wanted to report is that the Setup > Files Editor page is not being created on install. I tested on another PW site and the same thing. Once I manually created it, everything worked fine.

  • Like 1

Share this post


Link to post
Share on other sites

Hi, adrian!

I added a warning to the readme file for next versions, so that everyone should be aware that they need a backup solution in case they cut himself off the admin.

I'm not creating the page by myself, I'm letting PW do it for me:

$info = array(
    'title'   => 'Files Editor',
    'summary' => _('Edit files'),
    'version' => '1.6.3',
    'author'  => 'Florea Banus George, Matjaž Potočnik, Roland Toth',
    'icon'    => 'file-o',
    'href'    => 'https://github.com/matjazpotocnik/ProcessFileEdit/',
    'requires'  => 'ProcessWire>=2.5.5, PHP>=5.3.8',
    'permission'  => 'file-editor',
    'permissions' => array(
        'file-editor' => _('Edit Files (recommended for superuser only)')
    ),
    'page' => array(
        'name'   => 'file-editor',
        'parent' => 'setup',
        'title'  => 'Files Editor'
    ),
);

@adrian,would you be so kind and PM me, I would appreciate if you could give me more info about your server.

  • Like 1

Share this post


Link to post
Share on other sites

@matjazp i can confirm the fact that the page is not created, tested on both windows 10 and debian 8 with PW 3.0.40 and PHP 5.6

It worked with version 1.5.4.

  • Like 1

Share this post


Link to post
Share on other sites
1 hour ago, matjazp said:

I added a warning to the readme file for next versions, so that everyone should be aware that they need a backup solution in case they cut himself off the admin.

Sounds good - I guess it's really only issue if you are editing a file that is an autoload module, or perhaps a hook in something ready.php that is run whenever the admin loads.

1 hour ago, matjazp said:

I'm not creating the page by myself, I'm letting PW do it for me:

As @fbg13 noted that actually isn't working for some reason. I tried two different servers. As initial glance I am not sure why. I have used that 'page' => array approach successfully myself, although never in a info.php file - I wonder if perhaps that isn't working properly?

Share this post


Link to post
Share on other sites

It's not working, if the module has it's own install method. I added that in v1.6.1 to check for mbstring and iconv support. To overcome this you have to either remove your own install method or create a page by yourself, like this:

    public function ___install() {
        /*
        try {
            $this->installPage('file-editor', 'setup', 'Files Editor');
        } catch(Exception $e) {
            $this->error("Can't create a page.");
        }
        */
	parent::___install();
        if(!extension_loaded('mbstring') || !function_exists('iconv')) {
            $this->message("Support for mbstring and iconv is recommended.");
        }
    }

Thank you both for the report, v1.6.4 is up & running :-) 

Edit: I forgot to call parent::___install();

Edited by matjazp
  • 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 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!
    • By MoritzLost
      Sorry for the convoluted title. I have a problem with Process modules that define a custom page using the page key through getModuleInfo (as demonstrated in this excellent tutorial by @bernhard). Those pages are created automatically when the module is installed. The problem is that the title of the page only gets set in the current language. That's not a problem if the current language (language of the superuser who is installing the module) is the default language; if it isn't, the Process page is missing a title in the default language. This has the very awkward effect that a user using the backend in the default language (or any other language) will see an empty entry in the setup menu:

      This screenshot comes from my Cache Control module which includes a Process page. Now I realize the description sounds obscure, but for us it's a common setup: We a multiple bilingual sites where the default language is German and the second language is English. While the clients use the CMS in German, as a developer I prefer the English interface, so whenever I install a Process module I get this problem.
      As a module author, is there a way to handle this situation? I guess it would be possible to use post-installation hooks or create the pages manually, but I very much prefer the declarative approach. The page title is already translatable (through the __ function), but of course at the time of installation there is no translation, and as far as I'm aware it's not possible to ship translations with a module so they are used automatically. Could this situation be handled better in the core? I would prefer if the module installation process would always set the title of the Process page in the default language, instead of the language of the current user.
×
×
  • Create New...