Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[params] Add support for the general concept of a form parameter list
Signed-off-by: Michael Brown <mcb30@ipxe.org>
- Loading branch information
Showing
4 changed files
with
237 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,165 @@ | ||
/* | ||
* Copyright (C) 2013 Michael Brown <mbrown@fensystems.co.uk>. | ||
* | ||
* This program is free software; you can redistribute it and/or | ||
* modify it under the terms of the GNU General Public License as | ||
* published by the Free Software Foundation; either version 2 of the | ||
* License, or any later version. | ||
* | ||
* This program 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 | ||
* General Public License for more details. | ||
* | ||
* You should have received a copy of the GNU General Public License | ||
* along with this program; if not, write to the Free Software | ||
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA | ||
* 02110-1301, USA. | ||
*/ | ||
|
||
FILE_LICENCE ( GPL2_OR_LATER ); | ||
|
||
/** @file | ||
* | ||
* Form parameters | ||
* | ||
*/ | ||
|
||
#include <stdlib.h> | ||
#include <string.h> | ||
#include <ipxe/params.h> | ||
|
||
/** List of all parameter lists */ | ||
static LIST_HEAD ( parameters ); | ||
|
||
/** | ||
* Find form parameter list by name | ||
* | ||
* @v name Parameter list name (may be NULL) | ||
* @ret params Parameter list, or NULL if not found | ||
*/ | ||
struct parameters * find_parameters ( const char *name ) { | ||
struct parameters *params; | ||
|
||
list_for_each_entry ( params, ¶meters, list ) { | ||
if ( ( params->name == name ) || | ||
( strcmp ( params->name, name ) == 0 ) ) { | ||
return params; | ||
} | ||
} | ||
return NULL; | ||
} | ||
|
||
/** | ||
* Create form parameter list | ||
* | ||
* @v name Parameter list name (may be NULL) | ||
* @ret params Parameter list, or NULL on failure | ||
*/ | ||
struct parameters * create_parameters ( const char *name ) { | ||
struct parameters *params; | ||
size_t name_len; | ||
char *name_copy; | ||
|
||
/* Destroy any existing parameter list of this name */ | ||
params = find_parameters ( name ); | ||
if ( params ) | ||
destroy_parameters ( params ); | ||
|
||
/* Allocate parameter list */ | ||
name_len = ( name ? ( strlen ( name ) + 1 /* NUL */ ) : 0 ); | ||
params = zalloc ( sizeof ( *params ) + name_len ); | ||
if ( ! params ) | ||
return NULL; | ||
name_copy = ( ( void * ) ( params + 1 ) ); | ||
|
||
/* Populate parameter list */ | ||
if ( name ) { | ||
strcpy ( name_copy, name ); | ||
params->name = name_copy; | ||
} | ||
INIT_LIST_HEAD ( ¶ms->entries ); | ||
|
||
/* Add to list of parameter lists */ | ||
list_add_tail ( ¶ms->list, ¶meters ); | ||
|
||
DBGC ( params, "PARAMS \"%s\" created\n", params->name ); | ||
return params; | ||
} | ||
|
||
/** | ||
* Add form parameter | ||
* | ||
* @v params Parameter list | ||
* @v key Parameter key | ||
* @v value Parameter value | ||
* @ret param Parameter, or NULL on failure | ||
*/ | ||
struct parameter * add_parameter ( struct parameters *params, | ||
const char *key, const char *value ) { | ||
struct parameter *param; | ||
size_t key_len; | ||
size_t value_len; | ||
char *key_copy; | ||
char *value_copy; | ||
|
||
/* Allocate parameter */ | ||
key_len = ( strlen ( key ) + 1 /* NUL */ ); | ||
value_len = ( strlen ( value ) + 1 /* NUL */ ); | ||
param = zalloc ( sizeof ( *param ) + key_len + value_len ); | ||
if ( ! param ) | ||
return NULL; | ||
key_copy = ( ( void * ) ( param + 1 ) ); | ||
value_copy = ( key_copy + key_len ); | ||
|
||
/* Populate parameter */ | ||
strcpy ( key_copy, key ); | ||
param->key = key_copy; | ||
strcpy ( value_copy, value ); | ||
param->value = value_copy; | ||
|
||
/* Add to list of parameters */ | ||
list_add_tail ( ¶m->list, ¶ms->entries ); | ||
|
||
DBGC ( params, "PARAMS \"%s\" added \"%s\"=\"%s\"\n", | ||
params->name, param->key, param->value ); | ||
return param; | ||
} | ||
|
||
/** | ||
* Destroy form parameter list | ||
* | ||
* @v params Parameter list | ||
*/ | ||
void destroy_parameters ( struct parameters *params ) { | ||
struct parameter *param; | ||
struct parameter *tmp; | ||
|
||
DBGC ( params, "PARAMS \"%s\" destroyed\n", params->name ); | ||
|
||
/* Free all parameters */ | ||
list_for_each_entry_safe ( param, tmp, ¶ms->entries, list ) { | ||
list_del ( ¶m->list ); | ||
free ( param ); | ||
} | ||
|
||
/* Free parameter list */ | ||
list_del ( ¶ms->list ); | ||
free ( params ); | ||
} | ||
|
||
/** | ||
* Claim ownership of form parameter list | ||
* | ||
* @v params Parameter list | ||
*/ | ||
void claim_parameters ( struct parameters *params ) { | ||
|
||
DBGC ( params, "PARAMS \"%s\" claimed\n", params->name ); | ||
|
||
/* Remove from list of parameter lists */ | ||
list_del ( ¶ms->list ); | ||
|
||
/* Reinitialise list to allow for subsequent destroy_parameters() */ | ||
INIT_LIST_HEAD ( ¶ms->list ); | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
#ifndef _IPXE_PARAMS_H | ||
#define _IPXE_PARAMS_H | ||
|
||
/** @file | ||
* | ||
* Form parameters | ||
* | ||
*/ | ||
|
||
FILE_LICENCE ( GPL2_OR_LATER ); | ||
|
||
#include <ipxe/list.h> | ||
#include <ipxe/refcnt.h> | ||
|
||
/** A form parameter list */ | ||
struct parameters { | ||
/** List of all parameter lists */ | ||
struct list_head list; | ||
/** Name */ | ||
const char *name; | ||
/** Parameters */ | ||
struct list_head entries; | ||
}; | ||
|
||
/** A form parameter */ | ||
struct parameter { | ||
/** List of form parameters */ | ||
struct list_head list; | ||
/** Key */ | ||
const char *key; | ||
/** Value */ | ||
const char *value; | ||
}; | ||
|
||
/** Iterate over all form parameters in a list */ | ||
#define for_each_param( param, params ) \ | ||
list_for_each_entry ( (param), &(params)->entries, list ) | ||
|
||
extern struct parameters * find_parameters ( const char *name ); | ||
extern struct parameters * create_parameters ( const char *name ); | ||
extern struct parameter * add_parameter ( struct parameters *params, | ||
const char *key, const char *value ); | ||
extern void destroy_parameters ( struct parameters *params ); | ||
extern void claim_parameters ( struct parameters *params ); | ||
|
||
#endif /* _IPXE_PARAMS_H */ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters