Jump to content
adrian

Admin Actions

Recommended Posts

15 hours ago, tpr said:

I think the admin UI could be re-arranged into a table layout:

  • first column: action names
  • second column: description/notes
  • third column: applied roles + and Edit button, that opens a modal or perhaps only unhides the role asmSelector. Alternatively you can set the asmSelect to operate in "inline" mode, I've experimented with that and it worked.

I know it would take some time, but sooner or later this has to be done :)

 

You like to keep me busy don't you :)

How's this?

Screen Shot 2016-12-21 at 4.26.13 PM.png

That along with a few tweaks/fixes has been committed.

Don't forget to fork and contribute :)

  • Like 5

Share this post


Link to post
Share on other sites

Looks really sharp!  I'll print a screenshot and put it under the Christmas tree :)

One thing though. Doesn't cook coffee :)

  • Like 1

Share this post


Link to post
Share on other sites

Here are is a SCSS snippet if you would like to use inline roles (I'm not liking those big green asm items). It also enables removing roles by clicking on its label (not only on its icon), "user" icon instead trash and there's a line-through effect on hover too. You can use an online tool to make CSS from it.

Spoiler

table.adminactionsconfig {
  .Inputfield[id^="wrap_"] {
    background: transparent !important;
  }
  .InputfieldContent, label {
    padding: 0.25em 0.25em 0 !important;
    border: none !important;
    background: transparent !important;
  }
  .asmList {
    margin-top: 0.25em !important;
  }
  .asmListItem {
    padding-left: 8px !important;
    margin-right: 8px;
    display: inline-block !important;
    width: auto !important;
    font-size: 14px;
    background: transparent !important;
    border-color: transparent !important;
    color: inherit !important;
    &:hover {
      .asmListItemLabel {
        text-decoration: line-through !important;
      }
    }
    .asmListItemRemove {
      left: 0 !important;
      right: 0 !important;
      bottom: 0;
      top: 1px;
      &:not(:hover) {
        i {
          &:before {
            content: '\f007';
          }
        }
      }
    }
    i {
      margin-left: 2px;
      &:not(:hover) {
        color: #EA2262;
      }
    }
  }
}

 

 

adminactions-roles.gif

  • Like 3

Share this post


Link to post
Share on other sites

Thanks @tpr - I have implemented that, although I was a little hesitant. I certainly like the look, but I was worried about the consistency of the interface compared to what we're used to with ASM Selects. Curious why you haven't done this for the roles settings in AOS?

Share this post


Link to post
Share on other sites

Thanks! Good question - actually I haven't thought about that before your question. Perhaps because I didn't know that asmSelects can be used without the sort feature (although there's no need for that in AOS at all).

Share this post


Link to post
Share on other sites

The latest AOS contains this tweaked role selector appearance. Thanks for the tip! :)

The only difference is that I use the "user" icon even on hover, I think the line-through is enough signal for the removal.

Share this post


Link to post
Share on other sites

Merry Christmas, @adrian!

Want to try to use your action module in a slightly different way. I need to be able to execute actions from outside of PW (from emails). I am planning to solve this task kind of like in this module: I will have a page for each callable-from-outside action with some random security string and some options.

But I want to try to make it a little more customizable. I plan to write new actions for Admin Actions module, call them from API like you said it is possible to and pass options stored in some field of the callable-from-outside action page.

Do you see any caveats? Can you suggest a field to store options? Is there a way to turn off auto-backup feature (at least for the from-API usage or by configuration)?

  • Like 1

Share this post


Link to post
Share on other sites

Hi @Ivan Gretsky

I think I would store the options in a textarea in json format so you can easily convert to an array to pass to the action via the API call.

Are you planning on having the security string in the link from the email and handling the authentication in the logic on your pages? 

Currently the automatic backup can't be turned off, but I agree that this should be possible. I'll do it as a configurable option and also add an option to turn it off via an API call.

Let me know if you come across any issues once you start setting this up and I'll see what I can do to make AdminActions work as needed for you.

  • Like 2

Share this post


Link to post
Share on other sites

I did already managed to write a simple action and launch it via the API. I am currently going with a json in a textarea (but also looking at this field).

  1. Mandatory backup is problem 1.
  2. I had to give admin-action permission to the guest user. Not sure how dangerous is that. Is there a way to get around it?
  3. I am planning to have some security string stored in a dedicated field on the callable-from-outside action page which the token input value will have to match. Is there anything else you recommend?
  4. Not sure what you mean under handling authentication. Currently the script is running from the guest user.

Share this post


Link to post
Share on other sites

Hi @Ivan Gretsky - I've added some options for controlling the automatic backup (not committed yet) and I am thinking about the guest user access for making calls to actions via the API. I am considering a couple of different options and will put together something in the next couple of days. Hope that works for your timeframe?

 

  • Like 1

Share this post


Link to post
Share on other sites

Hi @Ivan Gretsky - ok, a new version has been committed that adds a new module config setting for determining whether database backups will be automatic, optional, or disabled.

1) Automatic - database backup will happen without user intervention.

2) Optional - adds a new checkbox at the bottom of every action's "options" form before the user clicks "Execute Action". 

3) Disabled - this means no database backup will occur.

If you do want to do a backup when calling an action via the API, simply add a new item to the options array: 

'dbBackup' => true

 

I am still working on figuring out the best approach for guest access. The biggest problem I see is that adding the "admin-actions" permission to the guest role means that any logged in user can now see the Setup > Admin Actions menu, even though they don't have permission to view or execute any of the actions.

I have been playing around with adding a new helper module to handle the API calls, rather than calling the main ProcessAdminActions module directly, but there are a couple of inheritance issues I am not thrilled about, so looking into other options. Will hopefully have a good solution soon.

Please let me know if the backup side of things handles your needs on that front.

 

  • Like 3

Share this post


Link to post
Share on other sites

Hi everyone,

I have committed a new version that takes care of @Ivan Gretsky's issues with guest access for calling actions via the API.

The new version also includes the ability to add actions to the Setup > Admin Actions submenu which could be really handy for quick access to key actions that you use regularly. At the moment you could add them all if you want, but perhaps in the future we'll have too many to make this usable, which is why I have made these configurable.

Screen Shot 2017-01-02 at 7.52.53 AM.png

 

See the new "In Menu" column:

Screen Shot 2017-01-02 at 7.53.40 AM.png

  • Like 6

Share this post


Link to post
Share on other sites

Thank you @adrian! It is amazing to watch something being created with such an amazing pace by people like you and ryan. And so much to learn from. I recommend everybody to go through these guys' code to learn how you can be really powerful using ProcessWire.

Another little idea. Not sure it is necessary, but seems logical to me to separate "core" actions and those specific to the site. Like core ans site modules. I can see this module to be a base to easily create little things that would other way need their own process modules. In that case, most of the time I would use only custom actions... A filter option or a tab. What do you think?

I know, that for everybody but admin I can achieve about the same with by-action role assignment. But as I almost always login a superuser myself...

  • Like 4

Share this post


Link to post
Share on other sites
6 hours ago, Martijn Geerts said:

Just to chime in: Fantastic Module @adrian

Thanks @Martijn Geerts - glad you're finding it useful - I appreciate the feedback!

 

20 hours ago, Ivan Gretsky said:

Another little idea. Not sure it is necessary, but seems logical to me to separate "core" actions and those specific to the site. Like core ans site modules. I can see this module to be a base to easily create little things that would other way need their own process modules. In that case, most of the time I would use only custom actions... A filter option or a tab. What do you think?

Hi @Ivan Gretsky - just to clarify - are you talking about simply separating the "core" actions in the module's "action" folder from those "site specific" ones in the /site/templates/AdminActions/ folder?

I think tabs sounds like a good approach - I'll take a look at doing that. Also something else to consider is the tables filter feature of @tpr's awesome AOS module - that will make finding actions nicer once there are lots more, although to be honest sometimes I just like good old CTRL/CMD + F :)

 

20 hours ago, Ivan Gretsky said:

I know, that for everybody but admin I can achieve about the same with by-action role assignment. But as I almost always login a superuser myself...

Just an FYI - if you don't want certain/any core actions available, you can remove the superuser role from those actions and they won't clog up your list of actions.

  • Like 1

Share this post


Link to post
Share on other sites

How about letting a dedicated AdminActions.module handle all the serious work (e.g. like WireActions), so actions are also triggerable via the api? I can imagine that some actions might be useful to be run as part of a migration (shameless plug :D) and not just via the backend.

  • Like 1

Share this post


Link to post
Share on other sites
22 hours ago, LostKobrakai said:

How about letting a dedicated AdminActions.module handle all the serious work (e.g. like WireActions), so actions are also triggerable via the api? I can imagine that some actions might be useful to be run as part of a migration (shameless plug :D) and not just via the backend.

 

They are already triggerable via the API: 

$options = array(
   'field' => 99, 
   'sourcePage' => 1131, 
   'destinationPage' => 1132
);
$modules->get("ProcessAdminActions")->CopyFieldContentToOtherPage($options);

I did think about separating into a core AdminActions.module and then have the ProcessAdminActions.module run on top of that, but went for the self-contained approach.

Let me know if this doesn't suit your needs though and I can revisit separating them out.

Share this post


Link to post
Share on other sites
On 1/2/2017 at 11:01 AM, Ivan Gretsky said:

Another little idea. Not sure it is necessary, but seems logical to me to separate "core" actions and those specific to the site.

Hi @Ivan Gretsky - I have implemented this - now both the modules settings and the Setup > AdminActions are split into "Site" and "Core" tabs. I haven't committed just yet. I will PM you the new version. Would appreciate it if you could test and let me know if it suits your needs and if you find any problems.

Thanks!

  • Like 2

Share this post


Link to post
Share on other sites

@Ivan Gretsky - I ended up doing some more tweaking on this and decided to commit it so you can get the new version from the modules directory now. Here's a screenshot of the tabs in action:

Screen Shot 2017-01-06 at 10.57.11 PM.png

 

I have also added a new: FTP Files to Page action based on this request: 

It works with files and images and looks like this:

Screen Shot 2017-01-06 at 6.57.31 PM.png

  • Like 2

Share this post


Link to post
Share on other sites

@adrian, I know function names are case-insensitive, but maybe you could change this line  from

 $destinationPage->$fieldName->add($item->getPathName());

to...

 $destinationPage->$fieldName->add($item->getPathname());// @note: lower 'n' in getPathname

to match what's in the docs...Just me being silly.:)

  • Like 1

Share this post


Link to post
Share on other sites

Thanks @kongondo - I was PHP was strict on function name case!

I think I inadvertently copied the case of $fieldName through to the getPathname() method.

Anyway, it's fixed in the latest version - thanks for noticing and pointing it out.

  • Like 1

Share this post


Link to post
Share on other sites

Just added a new "Email Batcher" action, which has the following features:

  • Select recipients by user role, or using a pages selector for any pages on the site
  • Parsing of field tags in the body so you can do something like: Dear {first_name}
  • Option to send a test email
  • HTML body, with automated text only version also sent
  • Special {fromEmail} and {adminUrl} tags.
  • Ability to hook EmailBatcher::parseBody to apply other custom replacements

Don't forget TracyDebugger's Mail panel when testing - it will capture the outgoing emails (so they won't actually be sent):
http://processwire.com/blog/posts/introducing-tracy-debugger/#mail-panel

joxi_screenshot_1484004786187.png

 

 

 

  • Like 4

Share this post


Link to post
Share on other sites

Just added a new "Copy Repeater Items To Other Page" action.

It lets you append or overwrite items from a repeater on one page to one on another.

  • Like 2

Share this post


Link to post
Share on other sites

Another quick update. Both the new "Copy Repeater Items To Other Page" and "Copy Table Field Rows To Other Page" actions now include an optional selector so you can define what repeater items / table rows will be copied.

 

  • Like 5

Share this post


Link to post
Share on other sites

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.

Guest
Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.


  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By teppo
      MarkupMenu is a markup module for generating menu trees. When provided a root page as a starting point, it generates a navigation tree (by default as a HTML "<ul>" element wrapped by a "<nav>" element) from that point onwards. If you've also provided it with current (active) page, the menu will be rendered accordingly, with current item highlighted and items rendered up to that item and its children (unless you disable the "collapsed" option, in which case the full page tree will be rendered instead).
      Modules directory: https://modules.processwire.com/modules/markup-menu/ GitHub repository: https://github.com/teppokoivula/MarkupMenu Usage
      As a markup module, MarkupMenu is intended for front-end use, but you can of course use it in a module as well. Typically you'll only need the render() method, which takes an array of options as its only argument:
      echo $modules->get('MarkupMenu')->render([ 'root_page' => $pages->get(1), 'current_page' => $page, ]); Note: if you omit root_page, site root page is used by default. If you omit current_page, the menu will be rendered, but current (active) page won't be highlighted etc.
      A slightly more complex example, based on what I'm using on one of my own sites to render a (single-level) top menu:
      echo $modules->get('MarkupMenu')->render([ 'current_page' => $page, 'templates' => [ 'nav' => '<nav class="{classes} menu--{menu_class_modifier}" aria-label="{aria_label}">%s</nav>', 'item_current' => '<a class="menu__item menu__item--current" href="{item.url}" tabindex="0" aria-label="Current page: {item.title}">{item.title}</a>', ], 'placeholders' => [ 'menu_class_modifier' => 'top', 'aria_label' => 'Main navigation', ], 'include' => [ 'root_page' => true, ], 'exclude' => [ 'level_greater_than' => 1, ], ]); Note: some things you see above may not be entirely sensible, such as the use of {menu_class_modifier} and {aria_label} placeholders. On the actual site the "nav" template is defined in site config, so I can define just these parts on a case-by-case basis while actual nav markup is maintained in one place.
      Please check out the README file for available render options. I'd very much prefer not to keep this list up to date in multiple places. Basically there are settings for defining "templates" for different parts of the menu (list, item, etc.), include array for defining rules for including in the menu and exclude array for the opposite effect, classes and placeholders arrays for overriding default classes and injecting custom placeholders, etc. 🙂
      MarkupMenu vs. MarkupSimpleNavigation
      TL;DR: this is another take on the same concept. There are many similarities, but also some differences – especially when it comes to the supported options and syntax. If you're currently using MarkupSimpleNavigation then there's probably no reason to switch over.
      I'd be surprised if anyone didn't draw lines between this module and Soma's awesome MarkupSimpleNavigation. Simply put, I've been using MSN (...) for a number of years, and it's been great – but there have been some smallish issues with it, particularly with the markup generation part, and it's also doing some things in a way that just doesn't work for me – the xtemplates thing being one of these. In many ways it's less about features, and more about style.
      In MarkupMenu I've tried to correct these little hiccups, modernise the default markup, and allow for more flexibility with placeholder variables and additional / different options. MarkupMenu was built for ProcessWire 3.0.112+ and PHP 7.1+, it's installable with Composer, and I have a few additional ideas (such as conditional placeholders) on my todo list.
      One smallish and rather specific difference is that MarkupMenu supports overriding default options via $config->MarkupMenu. I find myself redefining the default markup for every site, which until now meant that each site has a wrapper function for MarkupSimpleNavigation (to avoid code / config repetition), and this way I've been able to omit that 🙂
      Requirements
      ProcessWire >= 3.0.112 PHP >= 7.1.0 If you're working on an earlier version of ProcessWire or PHP, use MarkupSimpleNavigation instead.
    • By Robin S
      Repeater Images
      Adds options to modify Repeater fields to make them convenient for "page-per-image" usage. Using a page-per-image approach allows for additional fields to be associated with each image, to record things such as photographer, date, license, links, etc.
      When Repeater Images is enabled for a Repeater field the module changes the appearance of the Repeater inputfield to be similar (but not identical) to an Images field. The collapsed view shows a thumbnail for each Repeater item, and items can be expanded for field editing.
      Screencast

      Installation
      Install the Repeater Images module.
      Setup
      Create an image field to use in the Repeater field. Recommended settings for the image field are "Maximum files allowed" set to 1 and "Formatted value" set to "Single item (null if empty)". Create a Repeater field. Add the image field to the Repeater. If you want additional fields in the Repeater create and add these also. Repeater Images configuration
      Tick the "Activate Repeater Images for this Repeater field" checkbox. In the "Image field within Repeater" dropdown select the single image field. You must save the Repeater field settings to see any newly added Image fields in the dropdown. Adjust the image thumbnail height if you want (unlike the core Images field there is no slider to change thumbnail height within Page Edit). Note: the depth option for Repeater fields is not compatible with the Repeater Images module.
      Image uploads feature
      There is a checkbox to activate image uploads. This feature allows users to quickly and easily add images to the Repeater Images field by uploading them to an adjacent "upload" field.
      To use this feature you must add the image field selected in the Repeater Images config to the template of the page containing the Repeater Images field - immediately above or below the Repeater Images field would be a good position.
      It's recommended to set the label for this field in template context to "Upload images" or similar, and set the visibility of the field to "Closed" so that it takes up less room when it's not being used. Note that when you drag images to a closed Images field it will automatically open. You don't need to worry about the "Maximum files allowed" setting because the Repeater Images module overrides this for the upload field.
      New Repeater items will be created from the images uploaded to the upload field when the page is saved. The user can add descriptions and tags to the images while they are still in the upload field and these will be retained in the Repeater items. Images are automatically deleted from the upload field when the page is saved.
      Tips
      The "Use accordion mode?" option in the Repeater field settings is useful for keeping the inputfield compact, with only one image item open for editing at a time. The "Repeater item labels" setting determines what is shown in the thumbnail overlay on hover. Example for an image field named "image": {image.basename} ({image.width}x{image.height})  
      https://github.com/Toutouwai/RepeaterImages
      https://modules.processwire.com/modules/repeater-images/
    • By EyeDentify
      Hello There Guys.

      I am in the process of getting into making my first modules for PW and i had a question for you PHP and PW gurus in here.

      I was wondering how i could use an external library, lets say TwitterOAuth in my PW module.
      Link to library
      https://twitteroauth.com/

      Would the code below be correct or how would i go about this:
      <?PHP namespace ProcessWire; /* load the TwitterOAuth library from my Module folder */ require "twitteroauth/autoload.php"; use Abraham\TwitterOAuth\TwitterOAuth; class EyeTwitter extends WireData,TwitterOAuth implements Module { /* vars */ protected $twConnection; /* extend parent TwitterOAuth contructor $connection = new TwitterOAuth(CONSUMER_KEY, CONSUMER_SECRET, $access_token, $access_token_secret); */ public function myTwitterConnection ($consumer_key, $consumer_secret, $access_token, $access_token_secret) { /* save the connection for use later */ $this->twConnection = TwitterOAuth::__construct($consumer_key, $consumer_secret, $access_token, $access_token_secret); } } ?> Am i on the right trail here or i am barking up the wrong tree?
      I don´t need a complete solution, i just wonder if i am including the external library the right way.
      If not, then give me a few hint´s and i will figure it out.

      Thanks a bunch.

      /EyeDentify
    • By dimitrios
      Hello,
      this module can publish content of a Processwire page on a Facebook page, triggered by saving the Processwire page.
      To set it up, configure the module with a Facebook app ID, secret and a Page ID. Following is additional configuration on Facebook for developers:
      Minimum Required Facebook App configuration:
      on Settings -> Basics, provide the App Domains, provide the Site URL, on Settings -> Advanced, set the API version (has been tested up to v3.3), add Product: Facebook Login, on Facebook Login -> Settings, set Client OAuth Login: Yes, set Web OAuth Login: Yes, set Enforce HTTPS: Yes, add "http://www.example.com/processwire/page/" to field Valid OAuth Redirect URIs. This module is configurable as follows:
      Templates: posts can take place only for pages with the defined templates. On/Off switch: specify a checkbox field that will not allow the post if checked. Specify a message and/or an image for the post.
      Usage
      edit the desired PW page and save; it will post right after the initial Facebook log in and permission granting. After that, an access token is kept.
       
      Download
      PW module directory: http://modules.processwire.com/modules/auto-fb-post/ Github: https://github.com/kastrind/AutoFbPost   Note: Facebook SDK for PHP is utilized.


    • By kongondo
      FieldtypeRuntimeMarkup and InputfieldRuntimeMarkup
       
      Modules Directory: http://modules.processwire.com/modules/fieldtype-runtime-markup/
      GitHub: https://github.com/kongondo/FieldtypeRuntimeMarkup
      As of 11 May 2019 ProcessWire versions earlier than 3.x are not supported
      This module allows for custom markup to be dynamically (PHP) generated and output within a page's edit screen (in Admin).
       
      The value for the fieldtype is generated at runtime. No data is saved in the database. The accompanying InputfieldRuntimeMarkup is only used to render/display the markup in the page edit screen.
       
      The field's value is accessible from the ProcessWire API in the frontend like any other field, i.e. it has access to $page and $pages.
       
      The module was commissioned/sponsored by @Valan. Although there's certainly other ways to achieve what this module does, it offers a dynamic and flexible alternative to generating your own markup in a page's edit screen whilst also allowing access to that markup in the frontend. Thanks Valan!
       
      Warning/Consideration
      Although access to ProcessWire's Fields' admin pages is only available to Superusers, this Fieldtype will evaluate and run the custom PHP Code entered and saved in the field's settings (Details tab). Utmost care should therefore be taken in making sure your code does not perform any CRUD operations!! (unless of course that's intentional) The value for this fieldtype is generated at runtime and thus no data is stored in the database. This means that you cannot directly query a RuntimeMarkup field from $pages->find(). Usage and API
       
      Backend
      Enter your custom PHP snippet in the Details tab of your field (it is RECOMMENDED though that you use wireRenderFile() instead. See example below). Your code can be as simple or as complicated as you want as long as in the end you return a value that is not an array or an object or anything other than a string/integer.
       
      FieldtypeRuntimeMarkup has access to $page (the current page being edited/viewed) and $pages. 
       
      A very simple example.
      return 'Hello'; Simple example.
      return $page->title; Simple example with markup.
      return '<h2>' . $page->title . '</h2>'; Another simple example with markup.
      $out = '<h1>hello '; $out .= $page->title; $out .= '</h1>'; return $out; A more advanced example.
      $p = $pages->get('/about-us/')->child('sort=random'); return '<p>' . $p->title . '</p>'; An even more complex example.
      $str =''; if($page->name == 'about-us') { $p = $page->children->last(); $str = "<h2><a href='{$p->url}'>{$p->title}</a></h2>"; } else { $str = "<h2><a href='{$page->url}'>{$page->title}</a></h2>"; } return $str; Rather than type your code directly in the Details tab of the field, it is highly recommended that you placed all your code in an external file and call that file using the core wireRenderFile() method. Taking this approach means you will be able to edit your code in your favourite text editor. It also means you will be able to type more text without having to scroll. Editing the file is also easier than editing the field. To use this approach, simply do:
      return wireRenderFile('name-of-file');// file will be in /site/templates/ If using ProcessWire 3.x, you will need to use namespace as follows:
      return ProcessWire\wireRenderFile('name-of-file'); How to access the value of RuntimeMarkup in the frontend (our field is called 'runtime_markup')
       
      Access the field on the current page (just like any other field)
      echo $page->runtime_markup; Access the field on another page
      echo $pages->get('/about-us/')->runtime_markup; Screenshots
       
      Backend
       

       

       
      Frontend
       

×
×
  • Create New...