Jump to content

New Module: AppApi


Sebi

Recommended Posts

3 minutes ago, David Lumm said:

Hey all!

I was wondering, is there any concept of "middleware" or hooks that I could attach to so I could run something on every request?

At the moment I've got a couple of things I've added into every route function, but I can anticipate that list getting longer. Rather than copy and paste the same lines into each and potentially miss something, it would be great if I could run it before the route specific code runs. Is that possible @Sebi?

Hi HI David, in PW any function in a module that has ___ at the start, like ___handleApiRequest() in the AppAPI module you can use as a hook in your own code. See https://processwire.com/docs/modules/hooks/

  • Like 2
Link to comment
Share on other sites

21 hours ago, Sebi said:

Hi @thibaultvdb,

thank you for reporting this issue! 
I'll be honest: In my Apis I actually always use arrays as return values, so I didn't notice this bug. With version 1.1.2, which I just released, you can use a stdclass again instead of an array as return value. 

I hope everything is running smoothly again with your Api? I would be very happy about a short feedback!

hi @Sebi

Awesome, thanks for the quick feedback and fix. Normally I use a lot of array's myself but I had a specific case where a object was the ideal way to go 😛.
I'll test it out in the following days!
Version 1.1.1 is working good for me, however I'm not doing really special stuff with it at the moment so I'm not sure if my case is the best feedback 😛.
I'm just opening the api  for visitors so I can use it a little like a restApi (doing some fancy ajax stuff) and it's doing exactly what I would expect so great work!

If you want me to check some other parts, let me know!

Link to comment
Share on other sites

  • 3 weeks later...

Hi @Sebi, I ran into a bug:

Currently the Router::handleError() function incorrectly reports HTTP 500 errors that result from methods that should have remained silent, because they are called with the error control operator '@'.

As the PHP documentation on error control operators puts it: 

Quote

If you have set a custom error handler function with set_error_handler() then it will still get called, but this custom error handler can (and should) call error_reporting() which will return 0 when the call that triggered the error was preceded by an @.

I bumped into this while working on a project with some semi-broken images, where the APP API module kept throwing 500's from PW's ImageInspector class.
Exif issues can be rather difficult to handle sometimes..

The solution is simple: just add a check error_reporting() before the handleError method, for instance

  public static function handleError($errNo, $errStr, $errFile, $errLine)
    {
        if (error_reporting()) {
            $return = new \StdClass();
            $return->error = 'Internal Server Error';
            $return->devmessage = [
                'message' => $errStr,
                'location' => $errFile,
                'line' => $errLine
            ];
            self::displayOrLogError($return, 500);
        }
    }

 

 

  • Like 1
Link to comment
Share on other sites

I just released version 1.1.3 which resolves three issues that were reported recently:

  • Fixes an issue with the constructor signature of the modules AppApiException class (by @David Lumm, thanks for PR 🤗)
  • Fixes an issue with the error-handler, which made it mistakenly catch errors that should have been ignored via @ operator (Thanks to @eelkenet)
  • Switched from `wire('input')->url` to `$_SERVER['REQUEST_URI']` for reading the base-url, because ProcessWire's internal function transferred everything to lowercase. (Thanks to Github-user @pauldro)

Thank you all for your contributions!

  • Like 2
Link to comment
Share on other sites

  • 3 weeks later...

I've read the doco, installed the module & Twack and no matter what I try when retrieving a page, all I get back is a successful Promise or worse, an error message about invalid json. Using React/Nextjs and the page is published, viewable & using the basic-page template. The authorisation is single JWT and the client JS code is:

export async function PWPageByUrl(path)  {
  // url is correct and returns a result, just not the one I was expecing
    const res = await fetch(`${process.env.NEXT_PUBLIC_API_URL}/${process.env.NEXT_PUBLIC_API_VERSION}/page/${path}`, {
            headers: {
                'x-api-key': process.env.NEXT_PUBLIC_API_KEY,
                'authorization': process.env.NEXT_PUBLIC_TOKEN
            }
        }
    )
    const data = await res.json()
    if (!data) {
        return {
            notFound: true,
        }
    }
    return {
        props: {
            data
        }, // will be passed to the page component as props
    }
}

On the PW server side as per doco with routes modified for v1, I have:

Spoiler

<?php
namespace ProcessWire;

require_once wire('config')->paths->AppApi . "vendor/autoload.php";
require_once wire('config')->paths->AppApi . "classes/AppApiHelper.php";

require_once __DIR__ . '/TwackAccess.class.php';

$routes = [

    'v1' => [
        'page' => [
            ['OPTIONS', '{id:\d+}', ['GET', 'POST', 'UPDATE', 'DELETE']],
            ['OPTIONS', '{path:.+}', ['GET', 'POST', 'UPDATE', 'DELETE']],
            ['OPTIONS', '', ['GET', 'POST', 'UPDATE', 'DELETE']],

            ['GET', '{id:\d+}', TwackAccess::class, 'pageIDRequest'],
            ['GET', '{path:.+}', TwackAccess::class, 'pagePathRequest'],
            ['GET', '', TwackAccess::class, 'dashboardRequest'],

            ['POST', '{id:\d+}', TwackAccess::class, 'pageIDRequest'],
            ['POST', '{path:.+}', TwackAccess::class, 'pagePathRequest'],
            ['POST', '', TwackAccess::class, 'dashboardRequest'],

            ['UPDATE', '{id:\d+}', TwackAccess::class, 'pageIDRequest'],
            ['UPDATE', '{path:.+}', TwackAccess::class, 'pagePathRequest'],
            ['UPDATE', '', TwackAccess::class, 'dashboardRequest'],

            ['DELETE', '{id:\d+}', TwackAccess::class, 'pageIDRequest'],
            ['DELETE', '{path:.+}', TwackAccess::class, 'pagePathRequest'],
            ['DELETE', '', TwackAccess::class, 'dashboardRequest'],
        ],
        'file' => [
            ['OPTIONS', '{id:\d+}', ['GET']],
            ['OPTIONS', '{path:.+}', ['GET']],
            ['OPTIONS', '', ['GET']],

            ['GET', '{id:\d+}', TwackAccess::class, 'pageIDFileRequest'],
            ['GET', '{path:.+}', TwackAccess::class, 'pagePathFileRequest'],
            ['GET', '', TwackAccess::class, 'dashboardFileRequest']
        ]
    ]
];

and the TwackAccess class copy/pasted from the documentation, eg for pagePathRequest:

Spoiler


  <?php
	/**
     * General function for page-outputs:
     */
    protected static function pageRequest(Page $page) {
        // Exit if Twack is not installed
        if (!wire('modules')->isInstalled('Twack')) {
            throw new InternalServererrorException('Twack module not found.');
        }

        // This commands Twack to output a data-array instead of HTML:
        wire('twack')->enableAjaxResponse();

        // If the page has no template, is not accessable or is blocked (i.e. via hook),
        // we throw a ForbiddenException
        if (!$page->viewable()) {
            throw new ForbiddenException();
        }

        $ajaxOutput   = $page->render();

        // $ajaxOutput will contain JSON-code, so we have to decode it to prevent it is encoded twice:
        $results      = json_decode($ajaxOutput, true);

        // Now, $results is a clean PHP-array with the information generated by Twack-components:
        return $results;
    }

 

 

I'm obviously missing something. Help to get it working as expected much appreciated.

Thanks

 

Link to comment
Share on other sites

4 hours ago, psy said:

I'm obviously missing something. Help to get it working as expected much appreciated.

Hi @psy,

At first glance, I can't find any obvious error in your code. Can you please show me the server response you get for the "Invalid Json" errors? (You can see each request/response in your browser's developer-console in the network-tab. Feel free to DM me if you need support for that.)

I would try to take out some complexity first and leave Twack out of the queries for now. It's best to set up a test route that only returns a simple response. Insert this to your Routes.php:

'v1' => [
    'test' => [
        ['OPTIONS', '', ['GET']],
            ['GET', '', AppApiTest::class, 'test']
        ]
    ],
]

And create the AppApiTest-class:

<?php

namespace ProcessWire;

class AppApiTest {
    public static function test($data) {
        return [
          'test' => true,
          'success' => 'YEAH!'
        ];
    }
}

No token-authentication needed. If you get this response back in Javascript, we can be sure that the basic api connection works.

Link to comment
Share on other sites

@Sebi Thanks for the quick response. I'd already gone past that point both in PW and Postman so the connection is good.

I'd even written my own method in Examples to get a page by ID. Maybe not as sophisticated as yours but it too worked:

<?php namespace ProcessWire;

Class Example {
  
  	public static function test () {
		return ['test successful'];
	}

  
      public static function getPageById($data) {
        $data = AppApiHelper::checkAndSanitizeRequiredParameters($data, ['id|int']);

        $p = wire('pages')->get("id=$data->id");
        if(!$p->id) throw new \Exception('Page not found', 404);

        $response = new \StdClass();

        // Hardcode any data you need that does not have an inputfield field in the admin
        $response->id = $p->id;
        $response->name = $p->name;
        $response->path = $p->path;

        // This retrieves all the admin input fields. Does not (yet) get page images or files, just single entry data
        $fields = $p->getFields();
        foreach ($fields as $fld) {
            $fldName = $fld->name;
            $response->$fldName = $p->$fld;
        }

        return $response;
    }
}

This enabled me to get the page data into the NextJS client and embed in the 'template/component' as variables from any existing PW page.

My next exercise was to delve into the NextJS router so that I could retrieve pages via their path and those paths would appear in the URL. Couldn't work it out in my own PW code (no surprises there!). It was then I installed your Twack module and used the Twack routes & TwackAccess.class.php at which point I ran into the issues mentioned above.

I'm sure it's my lack of knowledge of REACT/NextJS rather than your code... Doesn't help when their doco doesn't match up with their examples in gitHub.

Even so, it would great to use your TwackAccess classes rather than reinventing the wheel.

 

 

 

Link to comment
Share on other sites

@psy So, just to make sure, that everything works well on the PHP side: You can make a request via Postman to the same url that you are trying to access via Javascript? And you get back the expected JSON-data?

Unfortunately, I don't know much about NextJS and React. I am actually an Angular or Vanilla Javascript developer. In an Angular environment I would use Angular's httpClient to make an api-call:

const params = new HttpHeaders({
	'x-api-key': environment.api_key
});
this.httpClient.get('https://my-test-domain.com/api/page/1042').subscribe(
	response => console.log("Api-Response: ", response)
);

I assume that React has a similar helper class as well. This makes a call to the page-route in my router-definition, which you can see here: https://github.com/Sebiworld/musical-fabrik.de/blob/master/site/api/Routes.php . It will return the ajax-results for the ProcessWire page with id 1042 in this case.

I prefer to use the httpClient (if available) instead of the fetch function, which you are using in your code-example above. Mainly because I found the fetch function very cumbersome to use when dealing with more complex parameter data. But for a vanilla-js project I needed to use it, so I wrote a helper class that is way more usable: https://github.com/Sebiworld/musical-fabrik.de/blob/master/site/templates/src/js/classes/AjaxCall.js

Here is how you can make an api-call:

const ajaxCall = new AjaxCall({
	method: 'GET',
	path: '/api/page/1042',
	headers: {
		'X-API-KEY': 'oiasnduz3498gfsubasd'
	}
});
ajaxCall.fetch().then(function(response){
  console.log('Api-response: ', response);
}).catch(function(response){
  console.log('Api-error: ', response);
});

I hope that helps you out 😊

  • Like 1
Link to comment
Share on other sites

I released v1.1.4 of AppApi. The update fixes a critical bug that occurred when routes were called with GET parameters.  (reported by @David Lumm, thanks for PR 🤗)

Because I was already at it, I outsourced the reading of the current route (which is then further used by FastRoute) to its own hookable function `___getCurrentUrl()`. This allows you in special use cases to subsequently influence the URL with your own hook function.

Link to comment
Share on other sites

  • 2 weeks later...

Hi @Sebi

kann you confirm that the latest PW (3.0.173) breaks AppApi (404 on the routes) or is it something on my part.

EDIT: confirmed it myself, Downgrading to 3.0.172 with no other changes solved the issue

Thank you!

  • Like 1
  • Thanks 1
Link to comment
Share on other sites

On 3/9/2021 at 4:41 PM, csaggo.com said:

confirmed it myself

Yep, everything I had working with AppApi and REACT/NextJS broke with the PW 3.0.173 upgrade. Downgrading is a short-term option but limits future PW upgrade benefits

  • Thanks 1
Link to comment
Share on other sites

Hi everyone! 

I did not have the time to look deep into it, but looks like version 3.0.173 has made some changes into the handling of hooks. Especially hooks for custom urls, like we do in AppApi. Previously we had to use a little workaround to get it done - we hook into 404 (site not found) exceptions and generate our own response, if the request was made for /api/... The new update seems to add a functionality, where our module can use an url, without doing the 404-hack. But the new functionality seems also to break some of the old functionality. 🤨

So, please wait with the 3.0.173 upgrade! Thank you @csaggo.com and @psy for mentioning it. I will have time to look into it on the weekend - pull requests or hints are very welcome!

  • Like 1
  • Thanks 2
Link to comment
Share on other sites

It is done. I have found the error. Version 1.1.5, which I just released, fixes the bug and makes AppApi fully compatible with ProcessWire versions >= 1.0.173 again.

For those interested in the details:
It was just a tiny little thing that caused the module to no longer be able to find out if an api url was requested. This is what the code for it looked like:

    protected function checkIfApiRequest() {
        $url = $this->sanitizer->url($this->input->url);

        // support / in endpoint url:
        $endpoint = str_replace('/', "\/", $this->endpoint);

        $regex = '/^\/' . $endpoint . '\/?.*/m';
        preg_match($regex, $url, $matches);

        return !!$matches;
    }

However, in ProcessWire versions >= 1.0.173, $this->input->url (or wire('input')->url) now no longer contains the requested URL (e.g. "/api/page/"), but already the URL of the 404 error page "/http404/". Thus, the module could no longer determine whether it should handle the request or not.

But the solution to the problem was easier than I thought. $_SERVER['REQUEST_URI'] still contains the correct value. So we use that now for this check. And because this would have worked before, we don't need to worry about AppApi not working with older ProcessWire versions now. The fixed version simply looks like this:

    protected function checkIfApiRequest() {
        $url = $this->sanitizer->url($_SERVER['REQUEST_URI']);

        // support / in endpoint url:
        $endpoint = str_replace('/', "\/", $this->endpoint);

        $regex = '/^\/' . $endpoint . '\/?.*/m';
        preg_match($regex, $url, $matches);

        return !!$matches;
    }

Finally, thank you again for your reports. And I hope that you can now run your apis with the latest ProcessWire versions again. Thank you for using AppApi! 🤩

  • Like 3
  • Thanks 1
Link to comment
Share on other sites

Thanks for the quick fix @Sebi! Are you planning on using the new url hooks in the future? I read about it yesterday and it feels like a much cleaner way to handle the requests to the API endpoint

Link to comment
Share on other sites

Absolutely! But I'm glad, that I could fix the old handler, so it will work regardless which ProcessWire version is used. I think it would make sense to additionally add the new hook functionality. It should grab the request before it triggers 404. But that is something that must be tested very carefully. 

  • Like 1
Link to comment
Share on other sites

How do you folks set up your front-end? Same as your back-end or using completely separate web space?

I am rethinking of how to structure my project using AppApi.

Cheers
Rudy

Link to comment
Share on other sites

  • 2 weeks later...

Want to change Auth::login process with session::login hook but not working. 
Can i extend auth::login process ?

// Routes.php

wire()->addHookBefore('Session::login', function (HookEvent $event) {
	// Get the object the event occurred on, if needed
	$session = $event->object;

	// Get values of arguments sent to hook (and optionally modify them)
	$name = $event->arguments(0);
	$pass = $event->arguments(1);
	$force = $event->arguments(2);

	//HERE another database check for login

	// changed for testing not working
	$name = "prouser";
	$pass = '';
	$force = true;

	// Populate back arguments (if you have modified them)
	$event->arguments(0, $name);
	$event->arguments(1, $pass);
	$event->arguments(2, $force);
});
// extend auth login

wire()->addHookBefore('Auth::doLogin', function (HookEvent $event) {
	$auth = $event->object;
	$event->replace = true;

	$event->return = [
		'jwt' => $auth->createSingleJWTToken(),
		'username' => "3254235"
	];
});


 

Edited by fliwire
fixed
Link to comment
Share on other sites

  • 4 weeks later...

Thank you for a great module! I have started to explore the many possibilities that this module opens up.

A note myself that might help someone else too: I have a shared hosting that uses FastCGI. I couldn't get the Basic authentication to work using the Authorization header. Adding the following line to .htaccess does the job (available in Apache HTTP Server 2.4.13 and later).

CGIPassAuth On

Earlier version of Apache may use

<IfModule mod_rewrite.c>
RewriteEngine on
RewriteRule .* - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization},L]
</IfModule>

Source: https://stackoverflow.com/questions/3663520/php-auth-user-not-set

 

  • Like 3
  • Thanks 1
Link to comment
Share on other sites

  • 3 weeks later...

hi need to add custom variable to every request .
Token has an_id value and need to fetch user data from another database. Tried bottom code but $tokenString is empty.

Simply need to add $token->an_id value to request $data object.

wire()->addHookBefore('Router::handle', function (HookEvent $event) {
    $auth = Auth::getInstance();
    $tokenString = Auth::getInstance()->getBearerToken();
    // if ($tokenString === null || !is_string($tokenString) || empty($tokenString)) {
    //     return false;
    // }

    // throws exception if token is invalid:
    // try {
    //     $secret = $auth->application->getTokenSecret();
    //     if (!$singleJwt) {
    //         $secret = $auth->application->getAccesstokenSecret();
    //     }
    //     $token = JWT::decode($tokenString, $secret, ['HS256']);
    // } catch (\Firebase\JWT\ExpiredException $e) {
    //     throw new AccesstokenExpiredException();
    // } catch (\Firebase\JWT\BeforeValidException $e) {
    //     throw new AccesstokenNotBeforeException();
    // } catch (\Throwable $e) {
    //     throw new AccesstokenInvalidException();
    // }

    $routeInfo = $event->arguments(0);
    $routeInfo[2]["an_id"] = $token->an_id;

    $event->arguments(0, $routeInfo);
});

 

Link to comment
Share on other sites

Hi masters,

I'm going to make a newbie question, but... I just can't make it work.

I've installed a new fresh processwire in xampp, the AppApi module, created an application and keeping the "api" endpoint.

But when I run "https://localhost/testeapi/api/test" in Insomnia, I get the standard "404 Page Not Found" instead AppApi error or sucess message.

It seems that the AppApi is never being called.

The https is correctly configured in xampp.

Thank you for any help.

ErrorMsg.png

Request.png

Link to comment
Share on other sites

Posted (edited)
12 hours ago, Bacos said:

It seems that the AppApi is never being called.

Hi @Bacos,

You're right: If the AppApi module had received the Api request correctly, even an incorrect request would be answered with an exception and a JSON response. You get a HTML-response, so the request is not received by the module.

Let's see... You send your request to https://localhost/testeapi/api/test - so your processwire root is https://localhost/testeapi/, am I right?

Can you please double-check if your module's config looks like this:

841572744_Bildschirmfoto2021-05-16um18_03_33.thumb.png.1c787d517c202630d3cd53ecc4144c52.png

Another reason for a 404 error could be that you have already created a page in the ProcessWire page tree that is accessible under the /api route. Since the module uses a hook on ProcessPageView::pageNotFound to intercept requests, there must not be a page serving the api route.

I think that's all the approaches I can think of for now. Was there perhaps already something suitable 🙃

Edited by Sebi
  • Thanks 1
Link to comment
Share on other sites

5 minutes ago, thomasaull said:

Doesnt the API Endpoint needs to be `testeapi/api` in this case?

@thomasaullThank you! You are right - AppApiModule->checkIfApiRequest() compares with the full path of $_SERVER['REQUEST_URI']. Because of that, we must give the full path to the module-config, even if the ProcessWire root is in a subfolder. @Bacos: If you have only api instead of testeapi/api in your configuration, that would result in an 404 error!

Link to comment
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 LuisM
      Symprowire is a PHP MVC Framework based and built on Symfony using ProcessWire 3.x as DBAL and Service-Provider
      It acts as a Drop-In Replacement Module to handle the Request/Response outside the ProcessWire Admin. Even tough Symfony or any other mature MVC Framework could be intimidating at first, Symprowire tries to abstract Configuration and Symfony Internals away as much as possible to give you a quick start and lift the heavy work for you.
      The main Goal is to give an easy path to follow an MVC Approach during development with ProcessWire and open up the available eco-system.
      You can find the GitHub Repo and more Information here: https://github.com/Luis85/symprowire
      Documentation
      The Symprowire Wiki https://github.com/Luis85/symprowire/wiki How to create a simple Blog with Symprowire https://github.com/Luis85/symprowire/wiki/Symprowire-Blog-Tutorial Last Update
      16.07.2021 // RC 1 v0.6.0 centralized ProcessWire access trough out the Application by wrapping to a Service https://github.com/Luis85/symprowire/releases/tag/v0.6.0-rc-1 Requirements
      PHP ^7.4 Fresh ProcessWire ^3.0.181 with a Blank Profile Composer 2 (v1 should work, not recommended) The usual Symfony Requirements Features
      Twig Dependency Injection Monolog for Symprowire Support for .env YAML Configuration Symfony Console and Console Commands Symfony Webprofiler Full ProcessWire access inside your Controller and Services Webpack Encore support Caveats
      Symfony is no small Framework and will come with a price in terms of Memory Usage and added Overhead. To give you a taste I installed Tracy Debugger alongside to compare ProcessWire profiling with the included Symfony Webprofiler

      So in a fresh install Symprowire would atleast add another 2MB of Memory usage and around 40ms in response time, should be less in production due to the added overhead of the Webprofiler in dev env
       
    • By FireWire
      Hello community!

      I want to share a new module I've been working on that I think could be a big boost for multi-language ProcessWire sites.

      Some background, I was looking for a way for our company website to be efficiently translated as working with human translators was pretty laborious and a lack of updating content created a divergence between languages. I, and several other devs here, have talked about translation integrations and have recognized the power that DeepL has. DeepL is an AI deep learning powered service that delivers translation quality beyond any automated service available. After access to the API was opened up to the US, I built Fluency, a DeepL translation integration for ProcessWire.
      Fluency brings automated translation to every multi-language field in the admin, and also provides a translation tool allowing the user to translate their text to any language without it being inside a template's field. With Fluency you can:
      Translate any plain textarea or text input Translate any CKEditor content (yes, with markup) Translate page names for fully localized URLs on every page Translate your in-template translation function wrapped strings Translate modules Fluency is free, and now so is DeepL
      Since this module was first built DeepL has introduced free Developer accounts that allow anyone to start using Fluency at zero cost and beginning with the version 0.3.0 release Fluency now supports free DeepL accounts. As of June 2021 DeepL supports translation to 26 languages and continues to offer more!
      Installation and usage is completely plug and play. Whether you're building a new multi-language site, need to update a site to multi-language, or simply want to stop manually translating a site and make any language a one-click deal, it could not be easier to do it. Fluency works by having you match the languages configured in ProcessWIre to DeepL's. You can have your site translating to any or all of the languages DeepL translates to in minutes (quite literally).
      Let's break out the screenshots...
      When the default language tab is shown, a message is displayed to let users know that translation is available. Clicking on each tab shows a link that says "Translate from English". Clicking it shows an animated overlay with the word "Translating..." cycling through each language and a light gradient shift. Have a CKEditor field? All good. Fluency will translated it and use DeepL's ability to translate text within HTML tags. CKEditor fields can be translated as easily and accurately as text/textarea fields.

      Repeaters and AJAX created fields also have translation enabled thanks to a JavaScript MutationObserver that searches for multi-language fields and adds translation as they're inserted into the DOM. If there's a multi-language field on the page, it will have translation added.

      Same goes for image description fields. Multi-language SEO friendly images are good to go.

      Creating a new page from one of your templates? Translate your title, and also translate your page name for native language URLs. (Not available for Russian, Chinese, or Japanese languages due to URL limitations). These can be changed in the "Settings" tab for any page as well so whether you're translating new pages or existing pages, you control the URLs everywhere.

      Language configuration pages are no different. Translate the names of your languages and search for both Site Translation Files (including all of your modules)

      Translate all of the static text in your templates as well. Notice that the placeholders are retained. DeepL is pretty good at recognizing and keeping non-translatable strings like that. If it is changed, it's easy to fix manually.

      Fluency adds a "Translate" item to the CMS header. When clicked this opens up a modal with a full translation tool that lets the user translate any language to any language. No need to leave the admin if you need to translate content from a secondary language back to the default ProcessWire language. There is also a button to get the current API usage statistics. DeepL account owners can set billing limitations via character count to control costs. This may help larger sites or sites being retrofitted keep an eye on their usage. Fluency can be used by users having roles given the fluency-translate permission.

      It couldn't be easier to add Fluency to your new or existing website. Simply add your API key and you're shown what languages are currently available for translation from/to as provided by DeepL. This list and all configuration options are taken live from the API so when DeepL releases new languages you can add them to your site without any work. No module updates, just an easy configuration. Just match the language you configured in ProcessWire to the DeepL language you want it to be associated with and you're done. Fluency also allows you to create a list of words/phrases that will not be translated which can prevent items such as brands and company names from being translated when they shouldn't

       
      Limitations:
      No "translate page" - Translating multiple fields can be done by clicking multiple translation links on multiple fields at once but engineering a "one click page translate" is not feasible from a user experience standpoint. The time it takes to translate one field can be a second or two, but cumulatively that may take much longer (CKEditor fields are slower than plain text fields). There may be a workaround in the future but it isn't currently on the roadmap. No "translate site" - Same thing goes for translating an entire website at once. It would be great, but it would be a very intense process and take a very (very) long time. There may be a workaround in the future but it isn't on the roadmap. No current support for Inline CKEditor fields - Handling for CKEditor on-demand hasn't been implemented yet, this is planned for a future release though and can be done. I just forgot about it because I've never really used that feature personally.. Alpha release - This module is in alpha. Releases should be stable and usable, but there may be edge case issues. Test the module thoroughly and please report any bugs via a Github issue on the repository or respond here. Please note that the browser plugin for Grammarly conflicts with Fluency (as it does with many web applications). To address this issue it is recommended that you disable Grammarly when using Fluency, or open the admin to edit pages in a private window where Grammarly may not be loaded. This is an issue that may not have a resolution as creating a workaround may not be possible. If you have insight as to how this may be solved please visit the Github page and file a bugfix ticket.
      Requirements:
      ProcessWire  3.0+ UIKit Admin Theme That's Fluency in a nutshell. A core effort in this module is to create it so that there is nothing DeepL related hard-coded in that would require updating it when DeepL offers new languages. I would like this to be a future-friendly module that doesn't require developer work to keep it up-to-date.
      The Module Is Free
      This is my first real module and I want to give it back to the community as thanks. This is the best CMS I've worked with (thank you Ryan & contributors) and a great community (thank you dear reader).
      DeepL Developer Accounts
      In addition to paid Pro Developer accounts, DeepL now offers no-cost free accounts. Now all ProcessWire developers and users can use Fluency at no cost.
      Learn more about free and paid accounts by visiting the DeepL website. Sign up for a Developer account, get an API key, and start using Fluency today.
      Download & Feedback
      Download the latest version here
      https://github.com/SkyLundy/Fluency-Translation/archive/main.zip
      Github repository:
      https://github.com/SkyLundy/Fluency-Translation
      File issues and feature requests here (your feedback and testing is greatly appreciated):
      https://github.com/SkyLundy/Fluency-Translation/issues
       
      Thank you! ¡Gracias! Ich danke Ihnen! Merci! Obrigado! Grazie! Dank u wel! Dziękuję! Спасибо! ありがとうございます! 谢谢你!

    • 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.

      Detailed records
      View mode "Detailed records" 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.

      Cached visitor records
      View modes other than "Detailed records" are cached visitor counts which will be collected on a daily basis from the detailed records. This procedure ensures a faster display even with a large number of data records. Another advantage is that the detailed records can be deleted while the cache remains. The cache can be updated manually or automatically in a specified time period. Multiple visits from the same IP address on the same day are counted as a single visitor.

      Upgrade from older versions
      Cached visitor counts is new in version 1.0.8. If you just upgraded from an older version you might expire a delay or even an error 500 if you display cached visitor counts. The reason for this is that the cache has to be created from the records. This can take longer if your database contains many records. Sometimes it might hit the maximally execution time. Don't worry about that and keep reloading the page until the cache is completely created.
      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 (-).

      New in version 1.1.0
      A new feature comes with version 1.1.0 which offers to record user names of loggedin visitors. Just activate "Record user names" and "Record loggedin user" in the module settings.
      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.
    • By clsource
      Inertia Adapter ProcessWire Module
      Hello! Long time no see.
      I created this module so you can use Inertia.js (https://inertiajs.com/) with ProcessWire.
      Description
      Inertia allows you to create fully client-side rendered, single-page apps, without much of the complexity that comes with modern SPAs. It does this by leveraging existing server-side frameworks.
      Inertia isn’t a framework, nor is it a replacement to your existing server-side or client-side frameworks. Rather, it’s designed to work with them. Think of Inertia as glue that connects the two. Inertia comes with three official client-side adapters (React, Vue, and Svelte).
      This is an adapter for ProcessWire. Inertia replaces PHP views altogether by returning JavaScript components from controller actions. Those components can be built with your frontend framework of choice.
      Links
      - https://github.com/joyofpw/inertia
      - https://github.com/joyofpw/inertia-svelte-mix-pw
      - https://inertiajs.com/
      Screenshots


       
    • By sms77io
      Hi all,
      we made a small module for sending SMS via Sms77.io. It supports sending to one and multiple users.
      You can download it from GitHub and follow the instructions on how to install it - it is quite easy. An API key is required for sending, get yours for free @ Sms77 and receive 0,50 €.
      Hope this helps somebody and we are open for improvement suggestions!
       
      Best regards
      André
×
×
  • Create New...