Jump to content
horst

WireMailSmtp

Recommended Posts

1 minute ago, adrian said:

Unfortunately this is probably a path to disaster these days - spam has made email painful and I think the only reliable option these days is to go with a transactional email service like MailGun, Postmark, SendInBlue etc. And be sure to spend the time to learn about and properly implement DKIM, SPF, and a DMARC policy.

ugh..ok.

but... it works fine from my localhost dev server though?!

Share this post


Link to post
Share on other sites
Just now, Jonathan Sachse Mikkelsen said:

ugh..ok.

but... it works fine from my localhost dev server though?!

I'll defer to horst on the troubleshooting of it actually sending. I am just talking about the deliverability issues you are likely to deal with. If the emails are only to site editors/staff you may be ok, but if they are being sent to site users then it's likely going to be an issue at least in my experience. Maybe others will disagree?

Share this post


Link to post
Share on other sites

pfffffff... ok everyone thanks for the replies!

but i think i just found the problem.

The client hadn't filled out the subject line field in the back-end, so i was trying to send emails with no subject lines.

so i guess all the send requests got filtered by a spam filter or something, or they were just invalid. But now they are being send.

Stupid mistake, which took way too many hours to correct! But that's web development for you i guess 😛 

  • Haha 1

Share this post


Link to post
Share on other sites

A great module that works absolutely fine out of the box but I am not happy having the SMTP password in plain text in the database. Is there maybe a reason I am just not getting why this is necessary?

  • Like 2

Share this post


Link to post
Share on other sites

Hi there,

I've been using Wire Mail for a while and now I would like to change its signature settings to send a signature along the email message "only when explicitly called via the API" (currently I have "automatically with every Message").

WireMail-signature-settings.png.a30ce971328a473dc13f39147919fcca.png

My questions are:

  1. How and where to call the signature API? That is, which code should I use and in which file should I add this code to have a "signature on demand"?
  2. I'm also using Form Builder and other PW modules that send emails with Wire Mail. How and where to set the signature via API for them, in particular for Form Builder?
  3. How to customise the signature if you don't want to use (and send) the Sender Signature set in Wire Mail module settings?

Share this post


Link to post
Share on other sites
On 3/3/2014 at 1:36 AM, horst said:

addSignature ( true | false ) - the default-behave is selectable in config screen, this can be overridden here
(only available if a signature is defined in the config screen)

Hi @LAPS,

current implementation only allows one signature, set in the config screen. The option only defines when it should be send: never everytime or defined via API.

Maybe it would be a nice addition to have a API method to pass in different signatures.

 

 

Edited by horst

Share this post


Link to post
Share on other sites

I've used this module a number of times and it works well. Now I am trying to use it in a multi-instance environment and am a bit stuck. Is this possible at all?

To explain: I have two sites (in a  PW multi-site setup - although I think the issue would be the same even if they were completely separate). "site" is a private admin site and "site-web" is a public website. "site-web" accesses "site" via an instance as described in https://processwire.com/blog/posts/multi-instance-pw3/.

"site" has a contact form which is accessed by "site-web" and has WireMailSmtp installed. When completed, an email is sent using $mail=wireMail(). This works fine when the public site is not a PW site. However, when it is a PW site (as "site-web" is), the context for WireMail is "site-web", not "site", so $mail returns a WireMail class, not a WireMailSmtp class. I cannot find a way to call WireMail in the right instance context. If I try and call WireMailSmtp directly, it is operating in the wrong context and fails.

I guess I could install a copy of WireMailSmtp on "site-web", but then I need to maintain the config on both sites. Besides it seems counter-intuitive that using a non-PW site for the public site should be easier than doing it in PW!

I'd be grateful for any ideas or insights.

Share this post


Link to post
Share on other sites

Can you give concrete examples to the following?

Are you able, and if so, how do you create your instances instance_A and instance_B, and which one is called from where?

You have to be aware that WireMailSmtp supports PW Versions up from 2.4.1 until now. There wasn't any multi instance available and it can be that it is not easily possible to implement it into the module. But it can be possible to find a simple to use and easy to maintainable way. Therefor, I need to know how you are using it, how the code snippets look like.

Where is your instance_A, where your instance_B,

how do you create the second instance,

where and how do you call the wireMail object?

 

Share this post


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

Where is your instance_A, where your instance_B,

In your terminology, lets say instance_B is "site" and instance_A is "site-web". Both sites sit under the same root, sharing the same wire/ (i.e. a multi-site installation).

17 minutes ago, horst said:

how do you create the second instance,

in _init.php (part of the template rendering) in instance_A:

$config->admin_site = new ProcessWire($config->paths->root . 'site/');

I use $config->admin_site so that it can be accessed anywhere (assuming the current context is instance_A).

20 minutes ago, horst said:

where and how do you call the wireMail object?

Ah, that's a bit (!) more complicated. Instance_A accesses a runtime markup field in instance_B thus:

$adminPage = $config->admin_site->pages->get("template=Availability, name=bawd-hall-availability");
$availabilityTable = $adminPage->runtime_markup_availability;

This field renders php in the file Availability.php, which lives in instance_B ("site")

Availability.php renders a form thus:

$out .= $config->admin_site->files->render($currentPath . 'booking_form.php');

where $currentPath is $files->currentPath(); - i.e. booking_form is a sibling of Availability. (BTW, Availability.php checks the host name in the headers to determine whether it is being called as a second instance or not).

booking_form's action is $_SERVER['REQUEST_URI'] (i.e. the original page, thus running Availability.php again). Availability.php tests (isset($_GET["submit"]) ) and if true processes the POST variables from the form. After validation, the mail is constructed from these variables with $mail = wireMail(); etc.

For more background (if you really want 😉 ) you can see here, where @kongondo was extremely helpful getting the RuntimeMarkup Fields module working in a multi-instance environment.

Share this post


Link to post
Share on other sites

@MarkE, it is not necessary for me to know what and which forms you are using and how you have organized this. 🙂

I only want to know where and how you call the WireMail object.

Is it in the runtime markup field? Where and how do you call it?

 

Share this post


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

Is it in the runtime markup field?

Yes. The php for that field is Availability.php, which is in instance_B, and calls mail as described above. Not sure what more info you want re "where and how". Abbreviated code for this script is below:

<?php namespace ProcessWire;
$headers = getallheaders();
$permittedNonPW = array_map('trim', array_map('strip_tags', explode(',', $page->bodyTop)));
$permittedPW = array_map('trim', array_map('strip_tags', explode(',', $page->bodyFoot)));
// If site is a PW site, then need to deal with the different instances
if (in_array($headers['Host'], $permittedPW)) {
    $site = $config->admin_site;
    $config->sitePages = $config->admin_site->pages;
} else {
    $site = wire();
    $config->sitePages = $pages;
}
/////////////////////////////////////////////////////////
// Process any form results:
///////////////////////////////////////////////////////////
// define variables and set to empty values
$name = $email_address = $phone = $fromToDate = $adults = $children = $pets = $provbooking = $message = $spambot = "";
$fromerror = $toerror = $radioerror = $propertyName = "";

function test_input($data) {
   //.........
    return $data;
}

if (isset($_GET["submit"])) {
    $out = '';
    if ($_SERVER["REQUEST_METHOD"] == "POST") {
        $propertyName = test_input($_POST["property"]);
        //...... //fill variables
    }
       //......
            $mail = wireMail();
            if($mail->className != 'WireMailSmtp') {
                wire()->log->save('debug', 'Could not get the right WireMail-Module (WireMailSmtp); found: ' . $mail->className);
            } else {
                $mail->to($to)
                    ->from($myemail)
                    ->subject($email_subject)
                    ->bodyHTML($email_body_top . $email_body);
                $numsent = $mail->send();
                if ($numsent > 0) {
                    //.....
                        $out .= '<script>alert("Your request has been submitted - you should receive an automated email acknowledgement shortly.")</script>';
                   //.....
    $url = strtok($_SERVER['REQUEST_URI'], '?');
    $out .= '<script>window.location.assign("' . $url . '");</script>';
    return $out;
}
///////////////////////////////////////////////
/////////////// MAIN PAGE ////////////////////
//////////////////////////////////////////////
$currentPath = $files->currentPath();
$out = ... // Fills the availability table ...
  
////////////////////Don't forget the form itself//////////////////////////////
if (in_array($headers['Host'], $permittedPW)){
    wire()->log->save('debug', 'Calling booking form sitePages = ' . $config->sitePages->get('/')->title . ', $headers["Host"] is ' . $headers["Host"]);
    $out .= $config->admin_site->files->render($currentPath . 'booking_form.php');
} else {
    $out .= wire()->files->render($config->paths->templates . 'RuntimeMarkup/booking_form.php');
}
//////////////////FINALLY RETURN THE OUTPUT!!!///////////////////////////
return $out;

This works fine for $permittedNonPW but not for $permittedPW.

Share this post


Link to post
Share on other sites

Yep, there are these line(s):

if (isset($_GET["submit"])) {
       //......
            $mail = wireMail();

This is very unspecific. You need to call explicitly a WireMail object from your desired instance! For example, if you are starting in your admin_instance, how do you fetch up your website_instance? 

You need to check if you really have an own instance of your $website_instance in your $admin_instance. If yes, pick up the $website_instance at that point above in the code and call the mail function of that instance: https://processwire.com/api/ref/wire-mail-tools/

As pseudo code:

if (isset($_GET["submit"])) {
       //......
       $myMailHandler = $myWebsiteInstance->wire('mail');  // or something like that

 

Also, in your code above you are using and overwriting(!) the predefined $mail variable, what should be omitted. Instead use your own name for that special instance mailhandler.

Share this post


Link to post
Share on other sites

Sorry - I forgot to say that I had tried various other things, including your suggestion. I've now done those things again (with $mailOwner rather than $mail - I'd forgotten that was predefined) and recorded the error in each case. These are reproduced below as a pair of lines - code followed by error:

$mailOwner = $config->admin_site->wire('mail');
Could not get the right WireMail-Module (WireMailSmtp); found: WireMailTools [My debugging line]
$mailOwner = $config->admin_site->mail->new();
 require_once(./WireMailSmtpAdaptor.php): failed to open stream: No such file or directory in M:\laragon\www\BawdHall\site\assets\cache\FileCompiler\site\modules\WireMailSmtp\WireMailSmtp.module on line 290

The second of these seems to be calling the right module (WireMailSmtp) but can't find the file because $config is always for instance_A. This seems similar to the issue we had with Runtime Markup.

Share this post


Link to post
Share on other sites

Have you debugged $config->admin_site? What is it? Your PW instance object? What debug output does it show when you call $config->admin_site->wire('config')? Also I had understand that your WireMailSmtp is installed and configured in the website-instance, not the admin-instance? Can you clarify that, please?

Which instance is the current started (running)? I thought the admin_instance, is this right?

Where is the WireMailSmtp installed and configured? I thought in the website_instance, is this right?

Share this post


Link to post
Share on other sites
3 hours ago, horst said:

Have you debugged $config->admin_site? What is it? Your PW instance object?

Yes. It is used extensively elsewhere in Availability.php and works fine.

3 hours ago, horst said:

What debug output does it show when you call $config->admin_site->wire('config')?

Config ($config->admin_site outputs ProcessWire 3.0.153 dev #1)

3 hours ago, horst said:

Which instance is the current started (running)? I thought the admin_instance, is this right?

No the host page is in site-web, which I think you are calling website_instance.

3 hours ago, horst said:

Where is the WireMailSmtp installed and configured? I thought in the website_instance, is this right?

No. It is in admin_instance, where the runtime markup field with Availability.php is.

Share this post


Link to post
Share on other sites

I have a temporary work-round, although less than ideal. I capture the form details and save it as a page in admin_instance (that works fine, using $config->admin_site). Then a LazyCron in the admin site picks up new forms and sends the emails. (I tried to use a hook after Pages::added, but it seems that this is not triggered when the page is added from another instance.) When the LazyCron runs, it is of course running in the admin instance.

EDIT: Actually there are pros and cons of the work-round method, so I will stick with it for now. Thanks for the comments @horst.

  • Like 1

Share this post


Link to post
Share on other sites

I read through all 14 pages, hoping to find some solution to my problem.

I learned that I can no use my regular Gmail password, instead an App Password was generated for my account and I have that in place in the settings 😉 Thanks to whomever suggested that!

I've gone through and entered all relevant fields pertaining to using Googles Gmail SMTP for my localhost testing. This is being done on my laptop running Linux (PopOS).

smtp hostname = smtp.gmail.com
smtp port = 587
smtp user/password = my gmail credentials and the generated app password
start tls checked, use ssl checked
 

I submit/save settings but I see no where where it says "SUCCESS! SMTP settings appear to work correctly" 😞

I have the following in a template:

<?php
	$to = 'organizedfellow@gmail.com';
	$from = 'organizedfellow@gmail.com';
	$subject = 'email testes';
	$textBody = 'this is the body of the test email';

	$numSent = wireMail($to, $from, $subject, $textBody);
?>

 

Share this post


Link to post
Share on other sites
13 hours ago, OrganizedFellow said:

start tls checked, use ssl checked

Not both! - either TLS or SSL

Share this post


Link to post
Share on other sites

hey @horst it's possible to override the smtp settings and use values on the fly while creating a wiremail instance? I have 3 different emails I need to use in my site. Thanks

Share this post


Link to post
Share on other sites

My debuglog is shortified (see last line). What can I do to get the complete log?

array (size=1)
  'DEBUGLOG' => string '

Resolving SMTP server domain "smtp.mailtrap.io"...<br />
Connecting to SMTP server "34.192.182.255" port 587...<br />
Connected to SMTP server "smtp.mailtrap.io".<br />
S 220 mailtrap.io ESMTP ready<br />
C EHLO pw-basic.local<br />
S 250-mailtrap.io<br />
S 250-SIZE 5242880<br />
S 250-PIPELINING<br />
S 250-ENHANCEDSTATUSCODES<br />
S 250-8BITMIME<br />
S 250-DSN<br />
S 250-AUTH PLAIN LOGIN CRAM-MD5<br />
S 250 STARTTLS<br />
C MAIL FROM:<noreply@foo.bar><br />
C '... (length=625)

 

Share this post


Link to post
Share on other sites
2 hours ago, rjgamer said:

My debuglog is shortified (see last line). What can I do to get the complete log?

To be honest: I don't know. I don't know why you have this, and I don't know how to change this. 😞

Share this post


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

To be honest: I don't know. I don't know why you have this, and I don't know how to change this. 😞

Foud the solution:

ini_set("xdebug.var_display_max_children", '-1');
ini_set("xdebug.var_display_max_data", '-1');
ini_set("xdebug.var_display_max_depth", '-1');

Source: https://stackoverflow.com/a/34342948/2338829

  • Like 1

Share this post


Link to post
Share on other sites

Hi 

I can't get wiremail to work ..
Can you show me a solution
Thanks so much

 

array(1) 
{
  ["SETTINGS"]                       array(28) 
  {
    ["default_charset"]              string(5) "UTF-8"
    ["localhost"]                    string(23) "domain.com"
    ["smtp_host"]                    string(17) "smtp.xxxxxxxx.com"
    ["smtp_port"]                    int(587)
    ["smtp_ssl"]                     string(0) ""
    ["smtp_ssl_crypto_method"]       string(0) ""
    ["smtp_start_tls"]               int(1)
    ["smtp_tls_crypto_method"]       string(31) "STREAM_CRYPTO_METHOD_ANY_CLIENT"
    ["smtp_user"]                    string(25) "admin@domain.com"
    ["smtp_password"]                string(12) "RBxxxxxxxgEPlj"
    ["smtp_password2"]               string(0) ""
    ["clear_smtp_password"]          string(0) ""
    ["allow_without_authentication"] string(0) ""
    ["realm"]                        string(0) ""
    ["workstation"]                  string(0) ""
    ["authentication_mechanism"]     string(0) ""
    ["smtp_debug"]                   int(0)
    ["smtp_html_debug"]              int(0)
    ["sender_name"]                  string(16) "Vincenzo xxxxxxx"
    ["sender_email"]                 string(25) "admin@domain.com"
    ["sender_reply"]                 string(0) ""
    ["sender_errors_to"]             string(0) ""
    ["sender_signature"]             string(0) ""
    ["sender_signature_html"]        string(0) ""
    ["send_sender_signature"]        string(1) "1"
    ["extra_headers"]                array(0) 
    {
    }
    ["valid_recipients"]             array(0) 
    {
    }
    ["smtp_certificate"]             string(0) ""
  }
}
array(1) 
{
  ["RESULT"]             array(5) 
  {
    ["subject"]          string(14) "Debug Testmail"
    ["addSignature"]     string(1) "0"
    ["textbody"]         string(39) "This is a test message"
    ["recipients"]       array(1) 
    {
      [0]                array(3) 
      {
        ["emailaddress"] string(24) "angelo.xxxxxxxx@email.com"
        ["name"]         string(0) ""
        ["type"]         string(2) "to"
      }
    }
    ["send"]             string(0) ""
  }
}
array(1) 
{
  ["ERRORS"] array(1) 
  {
    [0]      string(69) "could not connect to the host "smtp.xxxxxxx.com": Connection refused"
  }
}
array(1) 
{
  ["DEBUGLOG"] string(144) "

Resolving SMTP server domain "smtp.xxxxx.com"...
Connecting to SMTP server "smtp.xxxxxx.com" port 587...
"
}

Share this post


Link to post
Share on other sites

Dear friends,
the failure of the module depends on the hosting (godaddy). Below is the question solved ..
 
Sending emails through other providers in Godaddy is not allowed, so you need to use the following settings:

Port: 25
SMTP authentication: False or None
SSL or secure connection: None
Server or Host: The relay server to use depends on the type of hosting and script you use. What type is my hosting account?

Linux (cPanel)
Use localhost, unless:

You use a PHP script and the mail () function.
You use a Perl script and the binary / usr / lib / sendmail.
In these cases, you will not need to specify any relay servers.

 

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 David Karich
      ProcessWire InputfieldRepeaterMatrixDuplicate
      Thanks to the great ProModule "RepeaterMatrix" I have the possibility to create complex repeater items. With it I have created a quite powerful page builder. Many different content modules, with many more possible design options. The RepeaterMatrix module supports the cloning of items, but only within the same page. Now I often have the case that very design-intensive pages and items are created. If you want to use a content module on a different page (e.g. in the same design), you have to rebuild each item manually every time.
      This module extends the commercial ProModule "RepeaterMatrix" by the function to duplicate repeater items from one page to another page. The condition is that the target field is the same matrix field from which the item is duplicated. This module is currently understood as proof of concept. There are a few limitations that need to be considered. The intention of the module is that this functionality is integrated into the core of RepeaterMatrix and does not require an extra module.
      Check out the screencast
      What the module can do
      Duplicate multible repeater items from one page to another No matter how complex the item is Full support for file and image fields Multilingual support Support of Min and Max settings Live synchronization of clipboard between multiple browser tabs. Copy an item and simply switch the browser tab to the target page and you will immediately see the past button Support of multiple RepeaterMatrix fields on one page Configurable which roles and fields are excluded Configurable dialogs for copy and paste Duplicated items are automatically pasted to the end of the target field and set to hidden status so that changes are not directly published Automatic clipboard update when other items are picked Automatically removes old clipboard data if it is not pasted within 6 hours Delete clipboard itself by clicking the selected item again Benefit: unbelievably fast workflow and content replication What the module can't do
      Before an item can be duplicated in its current version, the source page must be saved. This means that if you make changes to an item and copy this, the old saved state will be duplicated Dynamic loading is currently not possible. Means no AJAX. When pasting, the target page is saved completely No support for nested repeater items. Currently only first level items can be duplicated. Means a repeater field in a repeater field cannot be duplicated. Workaround: simply duplicate the parent item Dynamic reloading and adding of repeater items cannot be registered. Several interfaces and events from the core are missing. The initialization occurs only once after the page load event Changelog
      2.0.0
      Feature: Copy multiple items at once! The fundament for copying multiple items was created by @Autofahrn - THX! Feature: Optionally you can disable the copy and/or paste dialog Bug fix: A fix suggestion when additional and normal repeater fields are present was contributed by @joshua - THX! 1.0.4
      Bug fix: Various bug fixes and improvements in live synchronization Bug fix: Items are no longer inserted when the normal save button is clicked. Only when the past button is explicitly clicked Feature: Support of multiple repeater fields in one page Feature: Support of repeater Min/Max settings Feature: Configurable roles and fields Enhancement: Improved clipboard management Enhancement: Documentation improvement Enhancement: Corrected few typos #1 1.0.3
      Feature: Live synchronization Enhancement: Load the module only in the backend Enhancement: Documentation improvement 1.0.2
      Bug fix: Various bug fixes and improvements in JS functions Enhancement: Documentation improvement Enhancement: Corrected few typos 1.0.1
      Bug fix: Various bug fixes and improvements in the duplication process 1.0.0
      Initial release Support this module
      If this module is useful for you, I am very thankful for your small donation: Donate 5,- Euro (via PayPal – or an amount of your choice. Thank you!)
      Download this module (Version 2.0.0)
      > Github: https://github.com/FlipZoomMedia/InputfieldRepeaterMatrixDuplicate
      > PW module directory: https://modules.processwire.com/modules/inputfield-repeater-matrix-duplicate/
      > Old stable version (1.0.4): https://github.com/FlipZoomMedia/InputfieldRepeaterMatrixDuplicate/releases/tag/1.0.4
    • By Robin S
      A new module that hasn't had a lot of testing yet. Please do your own testing before deploying on any production website.
      Custom Paths
      Allows any page to have a custom path/URL.
      Note: Custom Paths is incompatible with the core LanguageSupportPageNames module. I have no experience working with LanguageSupportPageNames or multi-language sites in general so I'm not in a position to work out if a fix is possible. If anyone with multi-language experience can contribute a fix it would be much appreciated!
      Screenshot

      Usage
      The module creates a field named custom_path on install. Add the custom_path field to the template of any page you want to set a custom path for. Whatever path is entered into this field determines the path and URL of the page ($page->path and $page->url). Page numbers and URL segments are supported if these are enabled for the template, and previous custom paths are managed by PagePathHistory if that module is installed.
      The custom_path field appears on the Settings tab in Page Edit by default but there is an option in the module configuration to disable this if you want to position the field among the other template fields.
      If the custom_path field is populated for a page it should be a path that is relative to the site root and that starts with a forward slash. The module prevents the same custom path being set for more than one page.
      The custom_path value takes precedence over any ProcessWire path. You can even override the Home page by setting a custom path of "/" for a page.
      It is highly recommended to set access controls on the custom_path field so that only privileged roles can edit it: superuser-only is recommended.
      It is up to the user to set and maintain suitable custom paths for any pages where the module is in use. Make sure your custom paths are compatible with ProcessWire's $config and .htaccess settings, and if you are basing the custom path on the names of parent pages you will probably want to have a strategy for updating custom paths if parent pages are renamed or moved.
      Example hooks to Pages::saveReady
      You might want to use a Pages::saveReady hook to automatically set the custom path for some pages. Below are a couple of examples.
      1. In this example the start of the custom path is fixed but the end of the path will update dynamically according to the name of the page:
      $pages->addHookAfter('saveReady', function(HookEvent $event) { $page = $event->arguments(0); if($page->template == 'my_template') { $page->custom_path = "/some-custom/path-segments/$page->name/"; } }); 2. The Custom Paths module adds a new Page::realPath method/property that can be used to get the "real" ProcessWire path to a page that might have a custom path set. In this example the custom path for news items is derived from the real ProcessWire path but a parent named "news-items" is removed:
      $pages->addHookAfter('saveReady', function(HookEvent $event) { $page = $event->arguments(0); if($page->template == 'news_item') { $page->custom_path = str_replace('/news-items/', '/', $page->realPath); } }); Caveats
      The custom paths will be used automatically for links created in CKEditor fields, but if you have the "link abstraction" option enabled for CKEditor fields (Details > Markup/HTML (Content Type) > HTML Options) then you will see notices from MarkupQA warning you that it is unable to resolve the links.
      Installation
      Install the Custom Paths module.
      Uninstallation
      The custom_path field is not automatically deleted when the module is uninstalled. You can delete it manually if the field is no longer needed.
       
      https://github.com/Toutouwai/CustomPaths
      https://modules.processwire.com/modules/custom-paths/
    • By teppo
      Hey folks!
      I'm happy to finally introduce a project I've been working on for quite a while now: it's called Wireframe, and it is an output framework for ProcessWire.
      Note that I'm posting this in the module development area, maily because this project is still in rather early stage. I've built a couple of sites with it myself, and parts of the codebase have been powering some pretty big and complex sites for many years now, but this should still be considered a soft launch 🙂
      --
      Long story short, Wireframe is a module that provides the "backbone" for building sites (and apps) with ProcessWire using an MVC (or perhaps MVVM... one of those three or four letter acronyms anyway) inspired methodology. You could say that it's an output strategy, but I prefer the term "output framework", since in my mind the word "strategy" means something less tangible. A way of doing things, rather than a tool that actually does things.
      Wireframe (the module) provides a basic implementation for some familiar MVC concepts, such as Controllers and a View layer – the latter of which consists of layouts, partials, and template-specific views. There's no "model" layer, since in this context ProcessWire is the model. As a module Wireframe is actually quite simple – not even nearly the biggest one I've built – but there's still quite a bit of stuff to "get", so I've put together a demo & documentation site for it at https://wireframe-framework.com/.
      In addition to the core module, I'm also working on a couple of site profiles based on it. My current idea is actually to keep the module very light-weight, and implement most of the "opinionated" stuff in site profiles and/or companion modules. For an example MarkupMenu (which I released a while ago) was developed as one of those "companion modules" when I needed a menu module to use on the site profiles.
      Currently there are two public site profiles based on Wireframe:
      site-wireframe-docs is the demo&docs site mentioned above, just with placeholder content replaced with placeholder content. It's not a particularly complex site, but I believe it's still a pretty nice way to dig into the Wireframe module. site-wireframe-boilerplate is a boilerplate (or starter) site profile based on the docs site. This is still very much a work in progress, but essentially I'm trying to build a flexible yet full-featured starter profile you can just grab and start building upon. There will be a proper build process for resources, it will include most of the basic features one tends to need from site to site, etc. --
      Requirements and getting started:
      Wireframe can be installed just like any ProcessWire module. Just clone or download it to your site/modules/ directory and install. It doesn't, though, do a whole lot of stuff on itself – please check out the documentation site for a step-by-step guide on setting up the directory structure, adding the "bootstrap file", etc. You may find it easier to install one of the site profiles mentioned above, but note that this process involves the use of Composer. In the case of the site profiles you can install ProcessWire as usual and download or clone the site profile directory into your setup, but after that you should run "composer install" to get all the dependencies – including the Wireframe module – in place. Hard requirements for Wireframe are ProcessWire 3.0.112 and PHP 7.1+. The codebase is authored with current PHP versions in mind, and while running it on 7.0 may be possible, anything below that definitely won't work. A feature I added just today to the Wireframe module is that in case ProcessWire has write access to your site/templates/ directory, you can use the module settings screen to create the expected directories automatically. Currently that's all, and the module won't – for an example – create Controllers or layouts for you, so you should check out the site profiles for examples on these. (I'm probably going to include some additional helper features in the near future.)
      --
      This project is loosely based on an earlier project called pw-mvc, i.e. the main concepts (such as Controllers and the View layer) are very similar. That being said, Wireframe is a major upgrade in terms of both functionality and architecture: namespaces and autoloader support are now baked in, the codebase requires PHP 7, Controllers are classes extending \Wireframe\Controller (instead of regular "flat" PHP files), implementation based on a module instead of a collection of drop-in files, etc.
      While Wireframe is indeed still in a relatively early stage (0.3.0 was launched today, in case version numbers matter) for the most part I'm happy with the way it works, and likely won't change it too drastically anytime soon – so feel free to give it a try, and if you do, please let me know how it went. I will continue building upon this project, and I am also constantly working on various side projects, such as the site profiles and a few unannounced helper modules.
      I should probably add that while Wireframe is not hard to use, it is more geared towards those interested in "software development" type methodology. With future updates to the module, the site profiles, and the docs I hope to lower the learning curve, but certain level of "developer focus" will remain. Although of course the optimal outcome would be if I could use this project to lure more folks towards that end of the spectrum... 🙂
      --
      Please let me know what you think – and thanks in advance!
    • By tcnet
      PageViewStatistic for ProcessWire is a module to log page visits of the CMS. The records including some basic information like IP-address, browser, operating system, requested page and originate page. Please note that this module doesn't claim to be the best or most accurate.
      Advantages
      One of the biggest advantage is that this module doesn't require any external service like Google Analytics or similar. You don't have to modify your templates either. There is also no JavaScript or image required.
      Disadvantages
      There is only one disadvantage. This module doesn't record visits if the browser loads the page from its browser cache. To prevent the browser from loading the page from its cache, add the following meta tags to the header of your page:
      <meta http-equiv="Cache-Control" content="no-cache, no-store, must-revalidate" /> <meta http-equiv="Pragma" content="no-cache" /> <meta http-equiv="Expires" content="0" /> How to use
      The records can be accessed via the Setup-menu of the CMS backend. The first dropdown control changes the view mode. There are 4 different view modes.
      View mode "Day" shows all visits of the selected day individually with IP-address, browser, operating system, requested page and originate page. Click the update button to see new added records. View mode "Month" shows the total of all visitors per day from the first to the last day of the selected month. View mode "Year" shows the total of all visitors per month from the first to the last month of the selected year. View mode "Total" shows the total of all visitors per year for all recorded years. Please note that multiple visits from the same IP address within the selected period are counted as a single visitor.
      Settings
      You can access the module settings by clicking the Configuration button at the bottom of the records page. The settings page is also available in the menu: Modules->Configure->ProcessPageViewStat.
      IP2Location
      This module uses the IP2Location database from: http://www.ip2location.com. This database is required to obtain the country from the IP address. IP2Location updates this database at the begin of every month. The settings of ProcessPageViewStat offers the ability to automatically download the database monthly. Please note, that automatically download will not work if your webspace doesn't allow allow_url_fopen.
      Dragscroll
      This module uses DragScroll. A JavaScript available from: http://github.com/asvd/dragscroll. Dragscroll adds the ability in view mode "Day" to drag the records horizontally with the mouse pointer.
      parseUserAgentStringClass
      This module uses the PHP class parseUserAgentStringClass available from: http://www.toms-world.org/blog/parseuseragentstring/. This class is required to filter out the browser type and operating system from the server request.
      Special Feature
      PageViewStatistic for ProcessWire can record the time a visitor viewed the page. This feature is deactivated by default. To activate open the module configuration page and activate "Record view time". If activated you will find a new column "S." in the records which means the time of view in seconds. With every page request, a Javascript code is inserted directly after the <body> tag. Every time the visitor switches to another tab or closes the tab, this script reports the number of seconds the tab was visible. The initial page request is recorded only as a hyphen (-).
       
    • By MoritzLost
      This module allows you to integrate hCaptcha bot / spam protection into ProcessWire forms. hCaptcha is a great alternative to Google ReCaptcha, especially if you are in the EU and need to comply with privacy regulations.

      The development of this module is sponsored by schwarzdesign.
      The module is built as an Inputfield, allowing you to integrate it into any ProcessWire form you want. It's primarily intended for frontend forms and can be added to Form Builder forms for automatic spam protection. There's a step-by-step guide for adding the hCaptcha widget to Form Builder forms in the README, as well as instructions for API usage.
      Features
      Inputfield that displays an hCaptcha widget in ProcessWire forms. The inputfield verifies the hCaptcha response upon submission, and adds a field error if it is invalid. All hCaptcha configuration options for the widget (theme, display size etc) can be changed through the inputfield configuration, as well as programmatically. hCaptcha script options can be changed through a hook. Error messages can be translated through ProcessWire's site translations. hCaptcha secret keys and site-keys can be set for each individual inputfield or globally in your config.php. Error codes and failures are logged to help you find configuration errors. Please check the README for setup instructions.
      Links
      Github Repository and documentation InputfieldHCaptcha in the module directory Screenshots (configuration)

      Screenshots (hCaptcha widget)

       
       

       
×
×
  • Create New...