src/WebHandlerImpl.h - master - nicodim4/ESPAsyncWebServer

src/WebHandlerImpl.h
101 строка4 KB
Emil Muratov
rework INM/IMS handling for AsyncStaticWebHandler
09 янв 2025, 05:41
09 янв 2025, 05:41175e182
/*
  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 <string>
#ifdef ASYNCWEBSERVER_REGEX
  #include <regex>
#endif

#include "stddef.h"
#include <time.h>

class AsyncStaticWebHandler : public AsyncWebHandler {
    using File = fs::File;
    using FS = fs::FS;

  private:
    bool _getFile(AsyncWebServerRequest* request) const;
    bool _searchFile(AsyncWebServerRequest* request, const String& path);
    uint8_t _countBits(const uint8_t value) const;

  protected:
    FS _fs;
    String _uri;
    String _path;
    String _default_file;
    String _cache_control;
    String _last_modified;
    AwsTemplateProcessor _callback;
    bool _isDir;
    bool _tryGzipFirst = true;

  public:
    AsyncStaticWebHandler(const char* uri, FS& fs, const char* path, const char* cache_control);
    bool canHandle(AsyncWebServerRequest* request) const override final;
    void handleRequest(AsyncWebServerRequest* request) override final;
    AsyncStaticWebHandler& setTryGzipFirst(bool value);
    AsyncStaticWebHandler& setIsDir(bool isDir);
    AsyncStaticWebHandler& setDefaultFile(const char* filename);
    AsyncStaticWebHandler& setCacheControl(const char* cache_control);

    /**
     * @brief Set the Last-Modified time for the object
     * 
     * @param last_modified 
     * @return AsyncStaticWebHandler& 
     */
    AsyncStaticWebHandler& setLastModified(const char* last_modified);
    AsyncStaticWebHandler& setLastModified(struct tm* last_modified);
    AsyncStaticWebHandler& setLastModified(time_t last_modified);
    // sets to current time. Make sure sntp is runing and time is updated
    AsyncStaticWebHandler& setLastModified();

    AsyncStaticWebHandler& setTemplateProcessor(AwsTemplateProcessor newCallback);
};

class AsyncCallbackWebHandler : public AsyncWebHandler {
  private:
  protected:
    String _uri;
    WebRequestMethodComposite _method;
    ArRequestHandlerFunction _onRequest;
    ArUploadHandlerFunction _onUpload;
    ArBodyHandlerFunction _onBody;
    bool _isRegex;

  public:
    AsyncCallbackWebHandler() : _uri(), _method(HTTP_ANY), _onRequest(NULL), _onUpload(NULL), _onBody(NULL), _isRegex(false) {}
    void setUri(const String& uri);
    void setMethod(WebRequestMethodComposite 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) const override final;
    void handleRequest(AsyncWebServerRequest* request) override final;
    void handleUpload(AsyncWebServerRequest* request, const String& filename, size_t index, uint8_t* data, size_t len, bool final) override final;
    void handleBody(AsyncWebServerRequest* request, uint8_t* data, size_t len, size_t index, size_t total) override final;
    bool isRequestHandlerTrivial() const override final { return !_onRequest; }
};

#endif /* ASYNCWEBSERVERHANDLERIMPL_H_ */