ESPAsyncWebServer/src/WebHandlerImpl.h

/*
  Asynchronous WebServer library for Espressif MCUs

  Copyright (c) 2016 Hristo Gochkov. All rights reserved.
  This file is part of the esp8266 core for Arduino environment.

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.

  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
*/
#ifndef ASYNCWEBSERVERHANDLERIMPL_H_
#define ASYNCWEBSERVERHANDLERIMPL_H_


#include "stddef.h"

class AsyncStaticWebHandler: public AsyncWebHandler {
  private:
    String _getPath(AsyncWebServerRequest *request, const bool withStats);
    bool _fileExists(const String path, const bool withStats);
    uint8_t _countBits(const uint8_t value);
  protected:
    FS _fs;
    String _uri;
    String _path;
    String _cache_header;
    bool _isDir;
    bool _gzipFirst;
    uint8_t _gzipStats;
    uint8_t _fileStats;
  public:
    AsyncStaticWebHandler(FS& fs, const char* path, const char* uri, const char* cache_header)
      : _fs(fs), _uri(uri), _path(path), _cache_header(cache_header){
      // Ensure leading '/'
      if (_uri.length() == 0 || _uri[0] != '/') _uri = "/" + _uri;
      if (_path.length() == 0 || _path[0] != '/') _path = "/" + _path;

      // If uri or path ends with '/' we assume a hint that this is a directory to improve performance.
      // However - if they both do not end '/' we, can't assume they are files, they can still be directory.
      bool isUriDir = _uri[_uri.length()-1] == '/';
      bool isPathDir = _path[_path.length()-1] == '/';
      _isDir = isUriDir || isPathDir;

      // If we serving directory - remove the trailing '/' so we can handle default file
      // Notice that root will be "" not "/"
      if (_isDir && isUriDir) _uri = _uri.substring(0, _uri.length()-1);
      if (_isDir && isPathDir) _path = _path.substring(0, _path.length()-1);

      // Reset stats
      _gzipFirst = false;
      _gzipStats = 0;
      _fileStats = 0;
    }
    bool canHandle(AsyncWebServerRequest *request);
    void handleRequest(AsyncWebServerRequest *request);
};

class AsyncCallbackWebHandler: public AsyncWebHandler {
  private:
  protected:
    String _uri;
    WebRequestMethod _method;
    ArRequestHandlerFunction _onRequest;
    ArUploadHandlerFunction _onUpload;
    ArBodyHandlerFunction _onBody;
  public:
    AsyncCallbackWebHandler() : _uri(), _method(HTTP_ANY), _onRequest(NULL), _onUpload(NULL), _onBody(NULL){}
    void setUri(String uri){ _uri = uri; }
    void setMethod(WebRequestMethod method){ _method = method; }
    void onRequest(ArRequestHandlerFunction fn){ _onRequest = fn; }
    void onUpload(ArUploadHandlerFunction fn){ _onUpload = fn; }
    void onBody(ArBodyHandlerFunction fn){ _onBody = fn; }

    bool canHandle(AsyncWebServerRequest *request){
      if(!_onRequest)
        return false;

      if(_method != HTTP_ANY && request->method() != _method)
        return false;

      if(_uri.length() && (_uri != request->url() && !request->url().startsWith(_uri+"/")))
        return false;

      request->addInterestingHeader("ANY");
      return true;
    }
    void handleRequest(AsyncWebServerRequest *request){
      if(_onRequest)
        _onRequest(request);
      else
        request->send(500);
    }
    void handleUpload(AsyncWebServerRequest *request, String filename, size_t index, uint8_t *data, size_t len, bool final){
      if(_onUpload)
        _onUpload(request, filename, index, data, len, final);
    }
    void handleBody(AsyncWebServerRequest *request, uint8_t *data, size_t len, size_t index, size_t total){
      if(_onBody)
        _onBody(request, data, len, index, total);
    }
};

#endif /* ASYNCWEBSERVERHANDLERIMPL_H_ */