`HTTP::GETDATA` 1g 2023-11-14 laplante@plcb.ca GOWEB/HTTP

author: laplante@plcb.ca date: 2023-11-14 title: “HTTP::GETDATA Function” version: 1.0.1 section: 1g

category: GOWEB/HTTP

Name

http::getdata — Read request parameters and handle file uploads

Synopsis

http::getdata([postonly: bool, uuid: bool, error: err, max_upload_size: int, max_upload_size_file: int, progress: string, action: string])

Description

The http::getdata function retrieves data sent either through query parameters or multipart form submissions. It also supports file uploads with advanced control such as file size limits, per-file configuration, and upload progress tracking.

When the progress parameter is set, the function records the upload status in a database table. The table must contain the following fields:

uuid: Unique key generated and returned by getdata.
size: File size in bytes.
read_file: Number of bytes read so far.
pourc: Percentage completed for the current file.
file: File name.
param: Current parameter name.
index_file: File index when multiple files are uploaded.
nb_file: Total number of files.
nb_file_done: Number of files already processed.
total_size: Total size of all files in bytes.
total_read: Total bytes read so far.
total_pourc: Overall upload percentage.

Uploaded data is not deleted after completion.

Example progress table

DROP TABLE IF EXISTS `progress_table`;
CREATE TABLE `progress_table` (
  `uuid` varchar(255) DEFAULT NULL,
  `size` int(11) DEFAULT NULL,
  `read_file` int(11) DEFAULT NULL,
  `pourc` double DEFAULT NULL,
  `file` varchar(1024) DEFAULT NULL,
  `param` varchar(255) DEFAULT NULL,
  `index_file` int(11) DEFAULT NULL,
  `nb_file` int(11) DEFAULT NULL,
  `nb_file_done` int(11) DEFAULT NULL,
  `total_size` int(11) DEFAULT NULL,
  `total_read` int(11) DEFAULT NULL,
  `total_pourc` double DEFAULT NULL,
  UNIQUE KEY `uuid` (`uuid`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_general_ci;

Example execution output

{
  "photo1": [
    {
      "content_type": "image/png",
      "filename": "moi.png",
      "filetype": "image/png",
      "new_filename": "1-1-1-1-1-1-1-moi.png",
      "param": "photo1",
      "size": 560879,
      "upload_dir": "/Users/laplante/go/src/goweb/www/upload"
    },
    {
      "content_type": "image/png",
      "filename": "Capture d’écran, le 2023-09-06 à 12.49.16.png",
      "filetype": "image/png",
      "new_filename": "1-Capture d’écran, le 2023-09-06 à 12.49.16.png",
      "param": "photo1",
      "size": 104981,
      "upload_dir": "/Users/laplante/go/src/goweb/www/upload"
    }
  ],
  "photo2": {
    "content_type": "image/png",
    "filename": "Capture d’écran, le 2023-09-13 à 06.54.27.png",
    "filetype": "image/png",
    "new_filename": "Capture d’écran, le 2023-09-13 à 06.54.27.png",
    "param": "photo2",
    "size": 310819,
    "upload_dir": "/Users/laplante/go/src/goweb/www/upload"
  },
  "upload_from": "",
  "uuid": "fc7edc9f-315b-4370-9395-d1baa37fc537"
}

Parameters

progress: If set, upload progress is stored in the database.
max_upload_size: Maximum allowed form upload size. Defaults to goweb.toml setting.
max_upload_size_file: Maximum allowed file size. Defaults to max_upload_size.
postonly: If true, query parameters are ignored and only POST data is processed.
action: Defines how to handle file naming conflicts:
- unique: Generate a unique filename and return an integer reference.
- rename: Preserve filename but append an incrementing number if it exists.
- error: Return an error if the file already exists.
- overwrite: Replace the existing file.

Examples

// Simple usage with default size
upload := getdata(error: err, max_upload_size: 1)

// Set maximum form size and per-file limits
upload := getdata(error: err, max_upload_size: 10000000, files: { "photo1": { "max_upload_size": 1 } })

// Restrict by allowed file types
upload := getdata(error: err, filetype: [ "a", "b" ])
upload := getdata(error: err, max_upload_size: 10000000, filetype: [ "image/png" ])

// Per-file type restrictions with action policy
upload := getdata(error: err, max_upload_size: 10000000, filetype: [ "image/png" ],
  files: { "photo1": { "max_upload_size": 10000000, "filetype": [ "image/jpeg" ] } })

upload := getdata(error: err, max_upload_size: 10000000, filetype: [ "image/png" ], action: "error")
upload := getdata(error: err, max_upload_size: 10000000, filetype: [ "image/png" ], action: "overwrite")
upload := getdata(error: err, max_upload_size: 10000000, filetype: [ "image/png" ], action: "rename")

// Per-file action override
upload := getdata(error: err, max_upload_size: 10000000, filetype: [ "image/png" ], action: "rename",
  files: { "photo2": { "action": "error" } })

Version

1.0.1 — 2023-12-12, added table creation example.
1.0.0 — 2023-11-04, initial version by laplante@plcb.ca

HTTP::GETDATA 1g 2023-11-14 laplante@plcb.ca GOWEB/HTTP