mirror
/
Cloudlog
kopia lustrzana https://github.com/magicbug/Cloudlog
1
0
Forkuj 0
Kod Zgłoszenia Packages Projekty Wydania Wiki Aktywność

Basic QO-100 Dx Club API integration

pull/2035/head
Hugo Silva 2023-03-16 18:58:48 +00:00
rodzic 363cda94bc
commit c962a972a8
6 zmienionych plików z 222 dodań i 62 usunięć
Pokaż statystyki Ściągnij plik aktualizacji Ściągnij plik porównania Expand all files Collapse all files

2
application/config/migration.php
Wyświetl plik

@ -21,7 +21,7 @@ $config['migration_enabled'] = TRUE;
| be upgraded / downgraded to.
|
*/
$config['migration_version'] = 114;
$config['migration_version'] = 115;
/*
|--------------------------------------------------------------------------

32
application/migrations/115_add_webadif_api_export.php 100644
Wyświetl plik

@ -0,0 +1,32 @@
<?php
defined('BASEPATH') OR exit('No direct script access allowed');
class Migration_add_webadif_api_export extends CI_Migration {
public function up()
{
$fields = array(
'webadifapikey varchar(50) DEFAULT NULL',
'webadifapiurl varchar(256) DEFAULT NULL',
'webadifrealtime bool DEFAULT FALSE',
);
$this->dbforge->add_column('station_profile', $fields);
$fields = array(
"webadif_upload_date datetime DEFAULT NULL",
"webadif_upload_status varchar(1) DEFAULT 'N'",
);
$this->dbforge->add_column($this->config->item('table_name'), $fields);
}
public function down()
{
$this->dbforge->drop_column('station_profile', 'webadifapikey');
$this->dbforge->drop_column('station_profile', 'webadifapiurl');
$this->dbforge->drop_column('station_profile', 'webadifrealtime');
$this->dbforge->drop_column($this->config->item('table_name'), 'webadif_upload_date');
$this->dbforge->drop_column($this->config->item('table_name'), 'webadif_upload_status');
}
}

190
application/models/Logbook_model.php
Wyświetl plik

@ -481,6 +481,25 @@ class Logbook_model extends CI_Model {
$this->mark_qrz_qsos_sent($last_id);
}
}
$result = $this->exists_webadif_api_key($data['station_id']);
// Push qso to webadif if apikey is set, and realtime upload is enabled, and we're not importing an adif-file
if (isset($result->webadifapikey) && $result->webadifrealtime == 1) {
$CI =& get_instance();
$CI->load->library('AdifHelper');
$qso = $this->get_qso($last_id)->result();
$adif = $CI->adifhelper->getAdifLine($qso[0]);
$result = $this->push_qso_to_webadif(
$result->webadifapiurl,
$result->webadifapikey,
$adif
);
if ($result) {
$this->mark_webadif_qsos_sent($last_id);
}
}
}
}
@ -503,6 +522,25 @@ class Logbook_model extends CI_Model {
}
}
/*
* Function checks if a WebADIF API Key exists in the table with the given station id
*/
function exists_webadif_api_key($station_id) {
$sql = 'select webadifapikey, webadifapiurl, webadifrealtime from station_profile
where station_id = ' . $station_id;
$query = $this->db->query($sql);
$result = $query->row();
if ($result) {
return $result;
}
else {
return false;
}
}
/*
* Function uploads a QSO to QRZ with the API given.
* $adif contains a line with the QSO in the ADIF format. QSO ends with an <EOR>
@ -545,6 +583,36 @@ class Logbook_model extends CI_Model {
curl_close($ch);
}
/*
* Function uploads a QSO to WebADIF consumer with the API given.
* $adif contains a line with the QSO in the ADIF format.
*/
function push_qso_to_webadif($url, $apikey, $adif) : bool{
$headers = array(
'Content-Type: text/plain',
'X-API-Key: ' . $apikey
);
if (substr($url, -1) !== "/") {
$url .= "/";
}
$ch = curl_init( $url . "qso");
curl_setopt( $ch, CURLOPT_POST, true);
curl_setopt( $ch, CURLOPT_POSTFIELDS, (string)$adif);
curl_setopt( $ch, CURLOPT_FOLLOWLOCATION, 1);
curl_setopt( $ch, CURLOPT_HEADER, 0);
curl_setopt( $ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, true);
$content = curl_exec($ch); // TODO: better error handling
$errors = curl_error($ch);
$response = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
return $response === 200;
}
/*
* Function marks QSOs as uploaded to QRZ.
* $primarykey is the unique id for that QSO in the logbook
@ -562,6 +630,24 @@ class Logbook_model extends CI_Model {
return true;
}
/*
* Function marks QSOs as uploaded to WebADIF.
* $primarykey is the unique id for that QSO in the logbook
*/
function mark_webadif_qsos_sent($primarykey)
{
$data = array(
'webadif_upload_date' => date("Y-m-d H:i:s", strtotime("now")),
'webadif_upload_status' => 'Y',
);
$this->db->where('COL_PRIMARY_KEY', $primarykey);
$this->db->update($this->config->item('table_name'), $data);
return true;
}
function upload_amsat_status($data) {
$sat_name = '';
if ($data['COL_SAT_NAME'] == 'AO-7') {
@ -1038,34 +1124,34 @@ class Logbook_model extends CI_Model {
return $this->db->get($this->config->item('table_name'));
}
// Set Paper to received
function paperqsl_update($qso_id, $method) {
$data = array(
'COL_QSLRDATE' => date('Y-m-d H:i:s'),
'COL_QSL_RCVD' => 'Y',
'COL_QSL_RCVD_VIA' => $method
);
$this->db->where('COL_PRIMARY_KEY', $qso_id);
$this->db->update($this->config->item('table_name'), $data);
}
// Set Paper to sent
function paperqsl_update_sent($qso_id, $method) {
$data = array(
'COL_QSLSDATE' => date('Y-m-d H:i:s'),
'COL_QSL_SENT' => 'Y',
'COL_QSL_SENT_VIA' => $method
);
$this->db->where('COL_PRIMARY_KEY', $qso_id);
$this->db->update($this->config->item('table_name'), $data);
}
@ -1219,10 +1305,10 @@ class Logbook_model extends CI_Model {
} else {
$logbooks_locations_array = $StationLocationsArray;
}
if ($logbooks_locations_array) {
$location_list = "'".implode("','",$logbooks_locations_array)."'";
$sql = "SELECT * FROM ( select * from " . $this->config->item('table_name'). "
WHERE station_id IN(". $location_list .")
order by col_time_on desc, col_primary_key desc
@ -1233,12 +1319,12 @@ class Logbook_model extends CI_Model {
order by col_time_on desc, col_primary_key desc";
$query = $this->db->query($sql);
return $query;
} else {
return null;
}
}
/* Get all QSOs with a valid grid for use in the KML export */
@ -1390,7 +1476,7 @@ class Logbook_model extends CI_Model {
} else {
return null;
}
}
/* Return QSOs over a period of days */
@ -1465,7 +1551,7 @@ class Logbook_model extends CI_Model {
// Return QSOs made during the current month
function month_qsos($StationLocationsArray = null) {
if($StationLocationsArray == null) {
if($StationLocationsArray == null) {
$CI =& get_instance();
$CI->load->model('logbooks_model');
$logbooks_locations_array = $CI->logbooks_model->list_logbook_relationships($this->session->userdata('active_station_logbook'));
@ -1617,17 +1703,17 @@ class Logbook_model extends CI_Model {
if ($searchCriteria['mode'] !== '') {
$this->db->group_start();
$this->db->where('COL_MODE', $searchCriteria['mode']);
$this->db->where('COL_MODE', $searchCriteria['mode']);
$this->db->or_where('COL_SUBMODE', $searchCriteria['mode']);
$this->db->group_end();
}
if ($searchCriteria['band'] !== '') {
if($searchCriteria['band'] != "SAT") {
$this->db->where('COL_BAND', $searchCriteria['band']);
$this->db->where('COL_PROP_MODE != "SAT"');
$this->db->where('COL_BAND', $searchCriteria['band']);
$this->db->where('COL_PROP_MODE != "SAT"');
} else {
$this->db->where('COL_PROP_MODE', 'SAT');
$this->db->where('COL_PROP_MODE', 'SAT');
}
}
@ -1746,7 +1832,7 @@ class Logbook_model extends CI_Model {
}
function get_QSLStats($StationLocationsArray = null) {
if($StationLocationsArray == null) {
$CI =& get_instance();
$CI->load->model('logbooks_model');
@ -1872,7 +1958,7 @@ class Logbook_model extends CI_Model {
$query = $this->db->get($this->config->item('table_name'));
$row = $query->row();
if($row == null) {
return 0;
} else {
@ -1995,7 +2081,7 @@ class Logbook_model extends CI_Model {
$this->db->where('COL_COUNTRY !=', 'Invalid');
$this->db->where('COL_DXCC >', '0');
$query = $this->db->get($this->config->item('table_name'));
return $query->num_rows();
} else {
return 0;
@ -2028,7 +2114,7 @@ class Logbook_model extends CI_Model {
/* Return total number of countries confirmed with along with qsl types confirmed */
function total_countries_confirmed($StationLocationsArray = null) {
if($StationLocationsArray == null) {
$CI =& get_instance();
$CI->load->model('logbooks_model');
@ -2040,7 +2126,7 @@ class Logbook_model extends CI_Model {
if(!empty($logbooks_locations_array)) {
$this->db->select('COUNT(DISTINCT COL_COUNTRY) as Countries_Worked,
COUNT(DISTINCT IF(COL_QSL_RCVD = "Y", COL_COUNTRY, NULL)) as Countries_Worked_QSL,
COUNT(DISTINCT IF(COL_EQSL_QSL_RCVD = "Y", COL_COUNTRY, NULL)) as Countries_Worked_EQSL,
COUNT(DISTINCT IF(COL_EQSL_QSL_RCVD = "Y", COL_COUNTRY, NULL)) as Countries_Worked_EQSL,
COUNT(DISTINCT IF(COL_LOTW_QSL_RCVD = "Y", COL_COUNTRY, NULL)) as Countries_Worked_LOTW');
$this->db->where_in('station_id', $logbooks_locations_array);
$this->db->where('COL_COUNTRY !=', 'Invalid');
@ -2346,7 +2432,7 @@ class Logbook_model extends CI_Model {
$this->db->join($this->config->item('table_name'),'station_profile.station_id = '.$this->config->item('table_name').'.station_id');
$this->db->where("coalesce(station_profile.eqslqthnickname, '') <> ''");
$this->db->where($this->config->item('table_name').'.COL_CALL !=', '');
$this->db->group_start();
$this->db->group_start();
$this->db->where($this->config->item('table_name').'.COL_EQSL_QSL_SENT is null');
$this->db->or_where($this->config->item('table_name').'.COL_EQSL_QSL_SENT', '');
$this->db->or_where($this->config->item('table_name').'.COL_EQSL_QSL_SENT', 'R');
@ -2858,11 +2944,11 @@ class Logbook_model extends CI_Model {
'COL_WWFF_REF' => (!empty($record['wwff_ref'])) ? $record['wwff_ref'] : '',
'COL_POTA_REF' => (!empty($record['pota_ref'])) ? $record['pota_ref'] : '',
'COL_SRX' => (!empty($record['srx'])) ? (int)$record['srx'] : null,
//convert to integer to make sure no invalid entries are imported
//convert to integer to make sure no invalid entries are imported
'COL_SRX_STRING' => (!empty($record['srx_string'])) ? $record['srx_string'] : '',
'COL_STATE' => (!empty($record['state'])) ? strtoupper($record['state']) : '',
'COL_STATION_CALLSIGN' => (!empty($record['station_callsign'])) ? $record['station_callsign'] : '',
//convert to integer to make sure no invalid entries are imported
//convert to integer to make sure no invalid entries are imported
'COL_STX' => (!empty($record['stx'])) ? (int)$record['stx'] : null,
'COL_STX_STRING' => (!empty($record['stx_string'])) ? $record['stx_string'] : '',
'COL_SUBMODE' => $input_submode,
@ -2971,14 +3057,14 @@ class Logbook_model extends CI_Model {
$callsign = $matches[3][0];
$suffix = $matches[5][0];
if ($prefix) {
$prefix = substr($prefix, 0, -1); # Remove the / at the end
$prefix = substr($prefix, 0, -1); # Remove the / at the end
}
if ($suffix) {
$suffix = substr($suffix, 1); # Remove the / at the beginning
};
if (preg_match($csadditions, $suffix)) {
if ($prefix) {
$call = $prefix;
$call = $prefix;
} else {
$call = $callsign;
}
@ -3052,7 +3138,7 @@ class Logbook_model extends CI_Model {
$call = "3D2/C"; # will match with Conway
} elseif (preg_match('/(^LZ\/)|(\/LZ[1-9]?$)/', $call)) { # LZ/ is LZ0 by DXCC but this is VP8h
$call = "LZ";
} elseif (preg_match('/(^KG4)[A-Z09]{2}/', $call)) {
} elseif (preg_match('/(^KG4)[A-Z09]{2}/', $call)) {
$call = "KG4";
} elseif (preg_match('/(^KG4)[A-Z09]{1}/', $call)) {
$call = "K";
@ -3062,14 +3148,14 @@ class Logbook_model extends CI_Model {
$callsign = $matches[3][0];
$suffix = $matches[5][0];
if ($prefix) {
$prefix = substr($prefix, 0, -1); # Remove the / at the end
$prefix = substr($prefix, 0, -1); # Remove the / at the end
}
if ($suffix) {
$suffix = substr($suffix, 1); # Remove the / at the beginning
};
if (preg_match($csadditions, $suffix)) {
if ($prefix) {
$call = $prefix;
$call = $prefix;
} else {
$call = $callsign;
}
@ -3120,38 +3206,38 @@ class Logbook_model extends CI_Model {
$a = '';
$b = '';
$c = '';
$lidadditions = '/^QRP$|^LGT$/';
$csadditions = '/^P$|^R$|^A$|^M$|^LH$/';
$noneadditions = '/^MM$|^AM$/';
# First check if the call is in the proper format, A/B/C where A and C
# are optional (prefix of guest country and P, MM, AM etc) and B is the
# callsign. Only letters, figures and "/" is accepted, no further check if the
# callsign "makes sense".
# 23.Apr.06: Added another "/X" to the regex, for calls like RV0AL/0/P
# as used by RDA-DXpeditions....
if (preg_match_all('/^((\d|[A-Z])+\/)?((\d|[A-Z]){3,})(\/(\d|[A-Z])+)?(\/(\d|[A-Z])+)?$/', $testcall, $matches)) {
# Now $1 holds A (incl /), $3 holds the callsign B and $5 has C
# We save them to $a, $b and $c respectively to ensure they won't get
# We save them to $a, $b and $c respectively to ensure they won't get
# lost in further Regex evaluations.
$a = $matches[1][0];
$b = $matches[3][0];
$c = $matches[5][0];
if ($a) {
$a = substr($a, 0, -1); # Remove the / at the end
$a = substr($a, 0, -1); # Remove the / at the end
}
if ($c) {
$c = substr($c, 1); # Remove the / at the beginning
};
# In some cases when there is no part A but B and C, and C is longer than 2
# letters, it happens that $a and $b get the values that $b and $c should
# have. This often happens with liddish callsign-additions like /QRP and
# /LGT, but also with calls like DJ1YFK/KP5. ~/.yfklog has a line called
# /LGT, but also with calls like DJ1YFK/KP5. ~/.yfklog has a line called
# "lidadditions", which has QRP and LGT as defaults. This sorts out half of
# the problem, but not calls like DJ1YFK/KH5. This is tested in a second
# try: $a looks like a call (.\d[A-Z]) and $b doesn't (.\d), they are
@ -3167,32 +3253,32 @@ class Logbook_model extends CI_Model {
$a = $temp;
}
}
# *** Added later *** The check didn't make sure that the callsign
# contains a letter. there are letter-only callsigns like RAEM, but not
# figure-only calls.
# figure-only calls.
if (preg_match('/^[0-9]+$/', $b)) { # Callsign only consists of numbers. Bad!
return null; # exit, undef
}
# Depending on these values we have to determine the prefix.
# Following cases are possible:
#
# 1. $a and $c undef --> only callsign, subcases
# 1.1 $b contains a number -> everything from start to number
# 1.2 $b contains no number -> first two letters plus 0
# 1.2 $b contains no number -> first two letters plus 0
# 2. $a undef, subcases:
# 2.1 $c is only a number -> $a with changed number
# 2.2 $c is /P,/M,/MM,/AM -> 1.
# 2.2 $c is /P,/M,/MM,/AM -> 1.
# 2.3 $c is something else and will be interpreted as a Prefix
# 3. $a is defined, will be taken as PFX, regardless of $c
# 3. $a is defined, will be taken as PFX, regardless of $c
if (($a == null) && ($c == null)) { # Case 1
if (preg_match('/\d/', $b)) { # Case 1.1, contains number
preg_match('/(.+\d)[A-Z]*/', $b, $matches); # Prefix is all but the last
$prefix = $matches[1]; # Letters
} else { # Case 1.2, no number
} else { # Case 1.2, no number
$prefix = substr($b, 0, 2) . "0"; # first two + 0
}
} elseif (($a == null) && (isset($c))) { # Case 2, CALL/X
@ -3204,12 +3290,12 @@ class Logbook_model extends CI_Model {
# like N66A/7 -> N7 this brings the wrong result of N67, but I
# think that's rather irrelevant cos such calls rarely appear
# and if they do, it's very unlikely for them to have a number
# attached. You can still edit it by hand anyway..
# attached. You can still edit it by hand anyway..
if (preg_match('/^([A-Z]\d)\d$/', $matches[1])) { # e.g. A45 $c = 0
$prefix = $matches[1] . $c; # -> A40
} else { # Otherwise cut all numbers
preg_match('/(.*[A-Z])\d+/', $matches[1], $match); # Prefix w/o number in $1
$prefix = $match[1] . $c; # Add attached number
$prefix = $match[1] . $c; # Add attached number
}
} elseif (preg_match($csadditions, $c)) {
preg_match('/(.+\d)[A-Z]*/', $b, $matches); # Known attachment -> like Case 1.1
@ -3241,7 +3327,7 @@ class Logbook_model extends CI_Model {
# case, the superfluous part will be cropped. Since this, however, changes the
# DXCC of the prefix, this will NOT happen when invoked from with an
# extra parameter $_[1]; this will happen when invoking it from &dxcc.
if (preg_match('/(\w+\d)[A-Z]+\d/', $prefix, $matches) && $i == null) {
$prefix = $matches[1][0];
}

24
application/models/Stations.php
Wyświetl plik

@ -81,10 +81,13 @@ class Stations extends CI_Model {
'oqrs' => xss_clean($this->input->post('oqrs', true)),
'oqrs_email' => xss_clean($this->input->post('oqrsemail', true)),
'oqrs_text' => xss_clean($this->input->post('oqrstext', true)),
'webadifapikey' => xss_clean($this->input->post('webadifapikey', true)),
'webadifapiurl' => 'https://qo100dx.club/api',
'webadifrealtime' => xss_clean($this->input->post('webadifrealtime', true)),
);
// Insert Records
$this->db->insert('station_profile', $data);
$this->db->insert('station_profile', $data);
}
function edit() {
@ -111,11 +114,14 @@ class Stations extends CI_Model {
'oqrs' => xss_clean($this->input->post('oqrs', true)),
'oqrs_email' => xss_clean($this->input->post('oqrsemail', true)),
'oqrs_text' => xss_clean($this->input->post('oqrstext', true)),
'webadifapikey' => xss_clean($this->input->post('webadifapikey', true)),
'webadifapiurl' => 'https://qo100dx.club/api',
'webadifrealtime' => xss_clean($this->input->post('webadifrealtime', true)),
);
$this->db->where('user_id', $this->session->userdata('user_id'));
$this->db->where('station_id', xss_clean($this->input->post('station_id', true)));
$this->db->update('station_profile', $data);
$this->db->update('station_profile', $data);
}
function delete($id) {
@ -132,7 +138,7 @@ class Stations extends CI_Model {
$this->db->delete($this->config->item('table_name'));
// Delete Station Profile
$this->db->delete('station_profile', array('station_id' => $clean_id));
$this->db->delete('station_profile', array('station_id' => $clean_id));
}
function deletelog($id) {
@ -145,7 +151,7 @@ class Stations extends CI_Model {
$data = array(
'user_id' => $this->session->userdata('user_id'),
);
$this->db->where('station_id', $id);
$this->db->update('station_profile', $data);
}
@ -160,7 +166,7 @@ class Stations extends CI_Model {
$data = array(
'user_id' => $id,
);
$this->db->update('station_profile', $data);
}
@ -192,7 +198,7 @@ class Stations extends CI_Model {
$this->db->where('user_id', $this->session->userdata('user_id'));
$this->db->update('station_profile', $current_default);
// Deselect current default
// Deselect current default
$newdefault = array(
'station_active' => 1,
);
@ -215,7 +221,7 @@ class Stations extends CI_Model {
return "0";
}
}
public function find_gridsquare() {
$this->db->where('user_id', $this->session->userdata('user_id'));
$this->db->where('station_active', 1);
@ -262,7 +268,7 @@ class Stations extends CI_Model {
);
$this->db->where('COL_STATION_CALLSIGN', $row->station_callsign);
if($row->station_iota != "") {
$this->db->where('COL_MY_IOTA', $row->station_iota);
}
@ -307,7 +313,7 @@ class Stations extends CI_Model {
return 1;
} else {
return 0;
}
}
}
function stations_with_qrz_api_key() {

15
application/views/station_profile/create.php
Wyświetl plik

@ -241,6 +241,21 @@
</div>
</div>
<div class="form-row">
<div class="form-group col-sm-6">
<label for="webadifApiKey"> QO-100 Dx Club API Key </label>
<input type="text" class="form-control" name="webadifapikey" id="webadifApiKey" aria-describedby="webadifApiKeyHelp">
<small id="webadifApiKeyHelp" class="form-text text-muted">Create your API key on <a href="https://qo100dx.club" target="_blank">your QO-100 Dx Club's profile page</a></small>
</div>
<div class="form-group col-sm-6">
<label for="webadifrealtime">QO-100 Dx Club Realtime Upload</label>
<select class="custom-select" id="webadifrealtime" name="webadifrealtime">
<option value="1">Yes</option>
<option value="0" selected>No</option>
</select>
</div>
</div>
<div class="form-group">
<label for="oqrs">OQRS Enabled</label>
<select class="custom-select" id="oqrs" name="oqrs">

21
application/views/station_profile/edit.php
Wyświetl plik

@ -356,6 +356,27 @@
</div>
</div>
<div class="row">
<div class="col-md">
<div class="card">
<h5 class="card-header">QO-100 Dx Club</h5>
<div class="card-body">
<div class="form-group">
<label for="webadifApiKey">QO-100 Dx Club API Key</label>
<input type="text" class="form-control" name="webadifapikey" id="webadifApiKey" aria-describedby="webadifApiKeyHelp" value="<?php if(set_value('webadifapikey') != "") { echo set_value('webadifapikey'); } else { echo $my_station_profile->webadifapikey; } ?>">
<small id="webadifApiKeyHelp" class="form-text text-muted">Create your API key on <a href="https://qo100dx.club" target="_blank">your QO-100 Dx Club's profile page</a></small>
</div>
<div class="form-group">
<label for="webadifrealtime">QO-100 Dx Club Realtime Upload</label>
<select class="custom-select" id="webadifrealtime" name="webadifrealtime">
<option value="1" <?php if ($my_station_profile->webadifrealtime == 1) { echo " selected =\"selected\""; } ?>>Yes</option>
<option value="0" <?php if ($my_station_profile->webadifrealtime == 0) { echo " selected =\"selected\""; } ?>>No</option>
</select>
</div>
</div>
</div>
</div>
</div>
<div class="row">
<div class="col-md">
<div class="card">