<h2 id="h1f0b8c33ec">C++ CGI Library [English]</h2><p><br>This library provides a simple interface for creating CGI (Common Gateway Interface) applications in C++. It enables the handling of GET and POST requests, parsing query strings and POST data, and managing session IDs.</p><h3 id="h6de55689cc">Features</h3><ul><li> <strong>Parse Query String: </strong>Easily parse query strings from GET requests into a <code>std::map</code>or convenient access to parameters.</li><li> <strong>Parse POST Data:</strong> Handle POST request data, parsing it into a <code>std::map</code>or easy parameter retrieval.</li><li><strong>Session Management: </strong>Generate and manage session IDs to maintain session state across requests.</li></ul><p>Request Handling: Retrieve values from either GET or POST requests based on the current request method.<br></p><h3 id="hf672955d96">About the source code</h3><h4 id="h4d98fcf7ca">CGI Class Description</h4><p><br>This CGI class is written in C++ and offers basic CGI (Common Gateway Interface) processing capabilities for web applications. By using this class, you can easily handle GET or POST requests from web forms and manage session IDs. Below is an overview of each method in the class.</p><h5 id="hc5fc41366c">Constructor</h5><ul><li><code>CGI()</code>: Automatically generates a session ID when an instance of the class is created.</li></ul><h5 id="hb7b926ea74">Methods</h5><ul><li><code> parseQueryString()</code>: Parses GET parameters from the URL's query string and returns them in a <code>std::map&lt;std::string, std::string&gt;</code>ormat, allowing access to query parameters as key-value pairs.</li><li><code>parse_post_data()</code>: Reads POST data from the standard input and returns it in a similar `<code>std::map&lt;std::string, std::string&gt;</code>` format.</li><li><code>POST_(std::string param)</code>: Retrieves the value of a specified POST parameter. Undefined behavior if the parameter does not exist.</li><li><code>GET_(std::string param)</code>: Retrieves the value of a specified GET parameter. Returns an empty string if the parameter does not exist.</li><li><code>REQUEST_(std::string param)</code><em>: </em>Determines whether the request is a GET or POST using the `<code>REQUESTTHOD</code>` environment variable and retrieves the parameter value accordingly.</li><li><code>GenerateSessionId()</code>: Randomly generates a session ID. This ID serves as a consistent identifier for a user throughout their visit to the site.</li><li><code>SESSION_ID()</code>: Retrieves the current session ID.</li></ul><p><br></p><h5 id="ha1c4fb8ac1">Usage Example</h5><p>This class is useful for handling user input and managing sessions in web applications. For instance, when a user submits information through a form, this class can be used to parse and process the data. Additionally, the session ID can be used to identify a user's session for authentication or state management purposes.<br></p><h5 id="h109a464da2">Compilation Guide</h5><p>To compile a C++ program that includes the CGI class, you need a C++ compiler such as <code>g++</code> or <code>clang++</code>. Here is a basic example of how to compile a program with <code>g++</code>:<br></p><ol><li>Save your program that includes the CGI class to a file, for example, <code>main.cpp</code>.</li><li>Open your terminal or command prompt.</li><li>Navigate to the directory where <code>main.cpp</code> is located.</li><li> Compile the program using the following command:</li></ol><pre><code>g++ main.cpp -std=c++11 -o ./cgi/main.cgi</code></pre><p>This command tells `<code>g++</code>` to compile `<code>main.cpp</code>` and output an executable named `<code>./cgi/main.cgi</code>`.<br><br></p><h5 id="hb2c20642d4">Notes</h5><p>- The `<code>parse_post_data()</code>` method uses `<code>std::cin</code>` to read POST data, so it only works in a CGI environment.<br>- The `<code>POST_</code>` method can result in undefined behavior if the key is not found, so it's important to either verify the key's existence beforehand or implement proper exception handling in actual use.<br>- The `<code>SESSION_ID</code>` method only returns the value if the session ID is not empty, but it's unlikely to encounter a situation where a session ID has not been generated.<br><br>This class provides a foundation for developing CGI-based web applications in C++, making it easier to process form data and manage sessions.<br></p><h4 id="h4d6900c17e">Usage</h4><h5 id="ha5548ffb0f">Download</h5><ul><li>Github: <a href="https://github.com/yymo10/cpp_cgi.git" target="_blank" rel="noopener noreferrer">https://github.com/yymo10/cpp_cgi.git</a></li><li>ZipFile : <a href="https://github.com/yymo10/cpp_cgi/archive/refs/heads/master.zip" target="_blank" rel="noopener noreferrer">https://github.com/yymo10/cpp_cgi/archive/refs/heads/master.zip</a></li></ul><h5 id="ha62b68d309">Including the Library</h5><p><br>Include the CGI library in your project by adding `<code>#include "CGI.h"</code>` to your source file.<br></p><h5 id="hce73a5e827">Creating an Instance</h5><p>Instantiate the CGI class in your application to start using its features.<br><br></p><pre><code>CGI cgi;</code></pre><p><br></p><h5 id="h0e53d39912">Handling Requests</h5><p>Retrieve a specific parameter value from either GET or POST requests:<br></p><pre><code>std::string value = cgi.REQUEST_("paramName");</code></pre><p><br></p><h5 id="ha72ebf292a">Session ID</h5><p>Retrieve the current session ID:</p><pre><code>std::string sessionId = cgi.SESSION_ID();</code></pre><h4 id="h002c2aab87">Contributing</h4><p>Contributions to the CGI library are welcome. Please ensure that your code adheres to the project's coding standards and include unit tests for new features or bug fixes.<br></p><h4 id="h807eadfa34">License</h4><p>This library is open-source and licensed under MIT License. Feel free to use it in your projects as per the license agreement.</p>

This library provides a simple interface for creating CGI (Common Gateway Interface) applications in C++. It enables the handling of GET and POST requests, parsing query strings and POST data, and managing session IDs.

CGI library for C++ Document 【English】

<h2 id="h699f8ed6b7">C++ CGI ライブラリ [日本語]</h2><p>このライブラリは、C++でCGI（Common Gateway Interface）アプリケーションを作成するためのシンプルなインターフェースを提供します。GETとPOSTのリクエストの処理、クエリ文字列とPOSTデータの解析、セッションIDの管理を可能にします。</p><h3 id="hdadc0eaacf">特徴</h3><ul><li><strong>クエリ文字列の解析：</strong> GETリクエストからクエリ文字列を簡単に解析し、パラメータへのアクセスを容易にするための`<code>std::map</code>`に格納します。</li><li><strong>POSTデータの解析：</strong> POSTリクエストデータを扱い、パラメータの取得を容易にするための`<code>std::map</code>`に解析します。</li><li><strong>セッション管理：</strong>セッションIDを生成および管理し、リクエスト間でのセッション状態を維持します。</li><li><strong>リクエスト処理：</strong> 現在のリクエストメソッドに基づいてGETまたはPOSTリクエストから特定のパラメータ値を取得します。</li></ul><h3 id="hd0767d8049">ソースコード</h3><h5 id="h0bc5905fe7">ダウンロード</h5><p><strong>CGI library for C++(Github)</strong></p><ul><li>Githubリポジトリ：<a href="https://github.com/yymo10/cpp_cgi.git" target="_blank" rel="noopener noreferrer">https://github.com/yymo10/cpp_cgi.git</a></li><li>Zipファイルダウンロード：<a href="https://github.com/yymo10/cpp_cgi/archive/refs/heads/master.zip" target="_blank" rel="noopener noreferrer">https://github.com/yymo10/cpp_cgi/archive/refs/heads/master.zip</a></li></ul><h5 id="h7fdb82b332">CGIクラス</h5><p>このCGIクラスは、C++で記述されたWebアプリケーションのための基本的なCGI (Common Gateway Interface) 処理機能を提供します。このクラスを使用することで、WebフォームからのGETまたはPOSTリクエストを簡単に処理し、セッションIDを生成して管理することができます。以下に、各メソッドの概要を説明します。</p><h5 id="h82dc1e5c5f">コンストラクタ</h5><ul><li><code>CGI()</code>: クラスのインスタンスが生成されると自動的にセッションIDを生成します。</li></ul><h5 id="hfd48a1d0b4">メソッド</h5><ul><li>`<code>parseQueryString()</code>`: URLのクエリストリングからGETパラメータを解析し、<code>std::map&lt;std::string, std::string&gt;</code>形式で返します。これにより、キーと値のペアでクエリパラメータにアクセスできます。</li><li> `<code>parse_post_data()</code>`: 標準入力からPOSTデータを読み取り、同様に<code>std::map&lt;std::string, std::string&gt;</code>形式で返します。</li><li> `<code>POST_(std::string param)</code>`: 指定されたPOSTパラメータの値を取得します。存在しない場合は未定義の動作をします。</li><li> `<code>GET_(std::string param)</code>`: 指定されたGETパラメータの値を取得します。パラメータが存在しない場合、空文字列を返します。</li><li> `<code>REQUEST_(std::string param)</code>`: 環境変数REQUEST_METHODを使用して、リクエストがGETまたはPOSTのどちらであるかを判断し、適切な方法でパラメータの値を取得します。</li><li> `<code>GenerateSessionId()</code>`: セッションIDをランダムに生成します。このIDは、ユーザーがサイトを訪問している間、一貫した識別子として機能します。</li><li> `<code>SESSION_ID()</code>`: 現在のセッションIDを取得します。</li></ul><h5 id="h512de7d259">使用例</h5><p>このクラスは、Webアプリケーションでユーザーからの入力を扱い、セッション管理を行う際に便利です。例えば、ユーザーがフォームを通じて情報を送信した場合、このクラスを使用してデータを解析し、処理することができます。さらに、セッションIDを使用して、ユーザーのセッションを特定し、認証や状態の管理に利用することが可能です。</p><h5 id="h86c1eb6dfa">注意点</h5><p><code>parse_post_data()</code>メソッドは、<code>std::cin</code>を使用してPOSTデータを読み取るため、CGI環境でのみ動作します。<br>POST_メソッドは、キーが見つからない場合に未定義の動作をしますので、実際の使用ではキーの存在を先に確認するか、例外処理を適切に行う必要があります。<br>SESSION_IDメソッドは、セッションIDが空でない場合にのみその値を返しますが、通常はセッションIDが生成されていない状況は発生しません。<br>このクラスは、C++でCGIベースのWebアプリケーションを開発する際の基盤として利用でき、フォームデータの処理やセッション管理を容易にします。</p><h5 id="h0e9d24c7ea">コンパイル手順について</h5><p>C++で記述されたCGIクラスを含むプログラムをコンパイルするには、`<code>g++</code>`や<code>`clang++</code>`などのC++コンパイラが必要です。以下に`<code>g++</code>`を使用したプログラムのコンパイル例を示します。</p><ol><li>CGIクラスを含むプログラムを<code>main.cpp</code>というファイルに保存します。</li><li>ターミナルまたはコマンドプロンプトを開きます。</li><li><code>main.cpp</code>が存在するディレクトリにナビゲートします。</li><li>以下のコマンドを使用してプログラムをコンパイルします。</li></ol><pre><code>g++ main.cpp -std=c++11 -o ./cgi/main.cgi</code></pre><p>このコマンドは<code>g++</code>に<code>main.cpp</code>をコンパイルし、実行可能ファイル<code>./cgi/main.cgi</code>を出力するよう指示します。</p><blockquote><strong>注意点</strong><br>ライブラリを格納しているディレクトリ指定がある場合、<code>./lib/</code>内のC++ファイルをすべて指定したディレクトリに格納する必要があります。</blockquote><h4 id="h4d849f4362">使い方</h4><h5 id="hd3e5557f4d">ライブラリのインクルード</h5><p>ソースファイルに`<code>#include "CGI.h"</code>`を追加してプロジェクトにCGIライブラリを含めます。</p><h5 id="h3596390140">インスタンスの作成</h5><p>アプリケーションでCGIクラスをインスタンス化し、その機能を使用開始します。</p><pre><code>CGI cgi;</code></pre><h5 id="h48cc173903">リクエストの処理</h5><p>GETまたはPOSTリクエストから特定のパラメータ値を取得するには</p><pre><code>std::string value = cgi.REQUEST_("paramName");</code></pre><h5 id="h5f8c253b4f">セッションID</h5><p>現在のセッションIDを取得するには：</p><pre><code>std::string sessionId = cgi.SESSION_ID();</code></pre><h3 id="hb05090920e">貢献について&nbsp;</h3><p>CGIライブラリに対する貢献を心から歓迎いたします。ご提供いただくコードがプロジェクトのコーディング規約に準拠していることをご確認の上、新たな機能追加やバグ修正には必ずユニットテストを添付してください。</p><h3 id="hc1b2f1de01">ライセンス</h3><p>本ライブラリはMITライセンスのもとでオープンソースとして公開されています。ライセンス契約の条件に従って、皆様のプロジェクトで自由にご利用いただけます。<br></p>

このライブラリは、C++でCGI（Common Gateway Interface）アプリケーションを作成するためのシンプルなインターフェースを提供します。GETとPOSTのリクエストの処理、クエリ文字列とPOSTデータの解析、セッションIDの管理を可能にします。

C++ライブラリ記事一覧

CGI library for C++ Document 【English】

CGI library for C++ ドキュメント【日本語】

TypeScript

Next.js

React

C++ ライブラリ

C++ライブラリ 記事一覧

CGI library for C++ Document 【English】

CGI library for C++ ドキュメント【日本語】

TypeScript

Next.js

React

C++ ライブラリ

C++ライブラリ記事一覧