class Analyzer::Cpp::Httplib

Overview

cpp-httplib (yhirose/cpp-httplib) — a header-only HTTP/HTTPS server & client library. Routes are registered on a httplib::Server (or SSLServer) instance: svr.Get("/path", handler), svr.Post, Put, Delete, Patch, Options. The handler is either an inline lambda or a named function. The library's Client type shares the same verb method names, so we only treat calls on a server variable as routes.

Defined in:

analyzer/analyzers/cpp/httplib.cr

Constant Summary

BODY_ACCESS = /\b(?:req|request)\s*\.\s*body\b/
CLIENT_DECL_BARE = /\b(?:SSL)?Client\s*&?\s*([A-Za-z_][A-Za-z0-9_]*)/
CLIENT_DECL_QUALIFIED = /\bhttplib::(?:SSL)?Client\s*&?\s*([A-Za-z_][A-Za-z0-9_]*)/
CPP_EXTENSIONS = [".cpp", ".cc", ".cxx", ".h", ".hpp", ".hxx"]
HEADER_ACCESSORS = /\b(?:get_header_value|has_header)\s*\(\s*"([^"]+)"/
NAMED_PARAM_REGEX = /:([A-Za-z_][A-Za-z0-9_]*)/

:name path placeholder (cpp-httplib named params).

PATH_PARAM_ACCESS = /\bpath_params\s*(?:\.\s*at\s*\(\s*|\[\s*)"([^"]+)"/
QUERY_ACCESSORS = /\b(?:get_param_value|has_param|get_file_value)\s*\(\s*"([^"]+)"/

Request accessors mined from a handler body.

REGEX_META = /[()\[\]\\+*?^$|]/

Regex metacharacters that mark a route pattern as a regex (kept verbatim).

ROUTE_CALL_REGEX = /\b([A-Za-z_][A-Za-z0-9_]*)\s*\.\s*(Get|Post|Put|Delete|Patch|Options)\s*\(/

receiver.Verb( — group 1 = receiver variable, group 2 = HTTP verb.

SERVER_DECL_BARE = /\b(?:SSL)?Server\s*&?\s*([A-Za-z_][A-Za-z0-9_]*)/
SERVER_DECL_QUALIFIED = /\bhttplib::(?:SSL)?Server\s*&?\s*([A-Za-z_][A-Za-z0-9_]*)/

httplib::Server / Server / SSLServer declarations and reference params.

VERB_CALL_EVIDENCE_RE = Regex.union(".Get(", ".Post(", ".Put(", ".Delete(", ".Patch(", ".Options(")

Precompiled union for the per-file verb-call evidence gate in analyze_file, so it costs a single PCRE2 match instead of up to six naive substring scans.

VERBS = {"Get" => "GET", "Post" => "POST", "Put" => "PUT", "Delete" => "DELETE", "Patch" => "PATCH", "Options" => "OPTIONS"}

Class Method Summary

Instance Method Summary

Instance methods inherited from class Analyzer

analyze analyze, base_path : String base_path, base_paths : Array(String) base_paths, base_relative_path(path : String) : String base_relative_path, callees_needed? : Bool callees_needed?, content_matches?(content : String, markers : Regex) : Bool content_matches?, http_header_name(name : String) : String | Nil http_header_name, line_number_for_index(content : String, char_index : Int32) : Int32 line_number_for_index, logger : NoirLogger logger, parallel_analyze(files : Array(String), &block : String -> Nil) parallel_analyze, read_file_content(path : String) : String read_file_content, result : Array(Endpoint) result, tech : String tech, unique_params(params : Array(Param)) : Array(Param) unique_params, url : String url, web_root_path(path : String, markers : Array(String)) : String web_root_path

Constructor methods inherited from class Analyzer

new(options : Hash(String, YAML::Any)) new

Macros inherited from class Analyzer

analyzer_for(tech) analyzer_for

Instance methods inherited from module FileHelper

all_files : Array(String) all_files, get_files_by_basename(basename : String) : Array(String) get_files_by_basename, get_files_by_extension(extension : String) : Array(String) get_files_by_extension, get_files_by_extensions(extensions : Array(String)) : Array(String) get_files_by_extensions, get_files_by_prefix(prefix : String) : Array(String) get_files_by_prefix, get_files_by_prefix_and_extension(prefix : String, extension : String) : Array(String) get_files_by_prefix_and_extension, get_files_by_relative_path(relative_path : String, root : String = "") : Array(String) get_files_by_relative_path, get_public_dir_files(base_path : String, folder : String) : Array(String) get_public_dir_files, get_public_files(base_path : String, anchors : Array(String) = ["shard.yml", "Gemfile"]) : Array(String) get_public_files, walked_path(expanded : String) : String walked_path

Class Method Detail

def self.tech_name : String #

[View source]

Instance Method Detail

def analyze #

[View source]
def tech : String #

Instance-side view of the same declaration. The per-file rescues live on this base class, which has no way to name the analyzer that is running inside them, so a skipped file could not be attributed to a tech. Deriving it from analyzer_for keeps the name written exactly once.


[View source]