public function init()
{
add_settings_section('podlove_settings_episode', __('', 'podlove'), function () {
echo '<h3>' . __('Download Tracking & Analytics Settings', 'podlove') . '</h3>';
?>
<style type="text/css">
.form-table .aligned-radio { display: table; margin-bottom: 10px; }
.form-table .aligned-radio .row { display: table-row; }
.form-table .aligned-radio .row > div { display: table-cell; }
</style>
<?php
}, Settings::$pagehook);
add_settings_field('podlove_setting_tracking', sprintf('<label for="mode">%s</label>', __('Tracking Mode', 'podlove')), function () {
?>
<label class="aligned-radio">
<div class="row">
<div>
<input name="podlove_tracking[mode]" type="radio" value="0" <?php
checked(\Podlove\get_setting('tracking', 'mode'), 0);
?>
/>
</div>
<div>
<?php
echo sprintf('<div><strong>%s</strong><br>%s</div>', __('No Tracking', 'podlove'), __('Original file URLs are presented to users and clients. No download-data is tracked.', 'podlove'));
?>
</div>
</div>
</label>
<label class="aligned-radio">
<div class="row">
<div>
<input name="podlove_tracking[mode]" type="radio" value="ptm" <?php
checked(\Podlove\get_setting('tracking', 'mode'), 'ptm');
?>
/>
</div>
<div>
<?php
echo sprintf('<div><strong>%s</strong><br>%s</div>', __('Tracking URL Parameters', 'podlove'), __('Original file URLs are extended by tracking parameters before presenting them to users and clients.
This is useful if you are using your server log files for download analytics.
No download-data is tracked.', 'podlove'));
?>
</div>
</div>
</label>
<label class="aligned-radio">
<div class="row">
<div>
<input name="podlove_tracking[mode]" type="radio" value="ptm_analytics" <?php
checked(\Podlove\get_setting('tracking', 'mode'), 'ptm_analytics');
?>
/>
</div>
<div>
<?php
echo sprintf('<div><strong>%s</strong><br>%s</div>', __('Tracking URL Parameters & Analytics', 'podlove'), __('Instead of the original file URLs, users and clients see a link that points to the Publisher.
The Publisher logs the download intent and redirects the user to the original file.
That way the Publisher is able to generate download statistics. ', 'podlove'));
?>
</div>
</div>
</label>
<?php
}, Settings::$pagehook, 'podlove_settings_episode');
add_settings_field('podlove_status_location_database', sprintf('<label for="mode">%s</label>', __('Geolocation Lookup', 'podlove')), function () {
$file = \Podlove\Geo_Ip::get_upload_file_path();
\Podlove\Geo_Ip::register_updater_cron();
?>
<?php
if (file_exists($file)) {
?>
<p>
<?php
echo __("Geolocation database", "podlove");
?>
:
<code><?php
echo $file;
?>
</code>
</p>
<p>
<?php
echo __("Last modified", "podlove");
?>
:
<?php
echo date(get_option('date_format') . ' ' . get_option('time_format'), filemtime($file));
?>
</p>
<p>
<?php
echo sprintf(__("The database is updated automatically once a month. Next scheduled update: %s", "podlove"), date(get_option('date_format') . ' ' . get_option('time_format'), wp_next_scheduled('podlove_geoip_db_update')));
?>
</p>
<p>
<button name="update_geo_database" class="button button-primary" value="1"><?php
echo __("Update Now", "podlove");
?>
</button>
</p>
<?php
} else {
?>
<p>
<?php
echo __("You need to download a geolocation-database for lookups to work.", "podlove");
?>
</p>
<p>
<button name="update_geo_database" class="button button-primary" value="1"><?php
echo __("Download Now", "podlove");
?>
</button>
</p>
<?php
}
?>
<p>
<!-- This snippet must be included, as stated here: http://dev.maxmind.com/geoip/geoip2/geolite2/ -->
<em>
This product includes GeoLite2 data created by MaxMind, available from
<a href="http://www.maxmind.com">http://www.maxmind.com</a>.
</em>
</p>
<?php
}, Settings::$pagehook, 'podlove_settings_episode');
add_settings_field('podlove_debug_tracking', sprintf('<label for="mode">%s</label>', __('Debug Tracking', 'podlove')), function () {
if (!\get_option('permalink_structure')) {
?>
<div class="error">
<p>
<b><?php
echo __('Please Change Permalink Structure', 'podlove');
?>
</b>
<?php
echo sprintf(__('You are using the default WordPress permalink structure.
This may cause problems with some podcast clients when you activate tracking.
Go to %s and set it to anything but default (for example "Post name") before activating Tracking.', 'podlove'), '<a href="' . admin_url('options-permalink.php') . '">' . __('Permalink Settings') . '</a>');
?>
</p>
</div>
<?php
}
$media_file = Model\MediaFile::find_example();
if (!$media_file) {
return;
}
$episode = $media_file->episode();
if (!$episode) {
return;
}
$public_url = $media_file->get_public_file_url("debug");
$actual_url = $media_file->get_file_url();
?>
<h4>Example Episode</h4>
<p>
<?php
echo $episode->full_title();
?>
</p>
<h4>Media File</h4>
<p>
<h5>Actual Location</h5>
<code><?php
echo $actual_url;
?>
</code>
</p>
<p>
<h5>Public URL</h5>
<code><?php
echo $public_url;
?>
</code>
</p>
<p>
<h5>Validations</h5>
<ul>
<li>
<!-- check rewrite rules -->
<?php
if (\Podlove\Tracking\Debug::rewrites_exist()) {
?>
✔ Rewrite Rules Exist
<?php
} else {
?>
✘ <strong>Rewrite Rules Missing</strong>
<!-- todo: repair button -->
<?php
}
?>
</li>
<li>
<?php
if (\Podlove\Tracking\Debug::url_resolves_correctly($public_url, $actual_url)) {
?>
✔ URL resolves correctly
<?php
} else {
?>
✘ <strong>URL does not resolve correctly</strong>
<?php
}
?>
</li>
<li>
<!-- check http/https consistency -->
<?php
if (\Podlove\Tracking\Debug::is_consistent_https_chain($public_url, $actual_url)) {
?>
✔ Consistent protocol chain
<?php
} else {
?>
✘ <strong>Protocol chain is inconsistent</strong>: Your site uses SSL but the files are not served with SSL.
Many clients will not allow to download episodes. To fix this, serve files via SSL or deactivate tracking.
<?php
}
?>
</li>
<!-- todo: check regularly and spit user in his face if it blows up -->
</ul>
</p>
<?php
}, Settings::$pagehook, 'podlove_settings_episode');
register_setting(Settings::$pagehook, 'podlove_tracking', function ($args) {
if (isset($_REQUEST['update_geo_database'])) {
\Podlove\Geo_Ip::update_database();
}
\Podlove\Cache\TemplateCache::get_instance()->setup_purge();
return $args;
});
}
public function add_geo_data($ip_string)
{
try {
$reader = new \GeoIp2\Database\Reader(\Podlove\Geo_Ip::get_upload_file_path());
} catch (\Exception $e) {
return $this;
}
try {
// geo ip lookup
$record = $reader->city($ip_string);
$this->lat = $record->location->latitude;
$this->lng = $record->location->longitude;
/**
* Get most specific area for given record, beginning at the given area-type.
*
* Missing records will be created on the fly, based on data in $record.
*
* @param object $record GeoIp object
* @param string $type Area identifier. One of: city, subdivision, country, continent.
*/
$get_area = function ($record, $type) use(&$get_area) {
// get parent area for the given area-type
$get_parent_area = function ($type) use($get_area, $record) {
switch ($type) {
case 'city':
return $get_area($record, 'subdivision');
break;
case 'subdivision':
return $get_area($record, 'country');
break;
case 'country':
return $get_area($record, 'continent');
break;
case 'continent':
// has no parent
break;
}
return null;
};
$subRecord = $record->{$type == 'subdivision' ? 'mostSpecificSubdivision' : $type};
if (!$subRecord->geonameId) {
return $get_parent_area($type);
}
if ($area = GeoArea::find_one_by_property('geoname_id', $subRecord->geonameId)) {
return $area;
}
$area = new GeoArea();
$area->geoname_id = $subRecord->geonameId;
$area->type = $type;
if (isset($subRecord->code)) {
$area->code = $subRecord->code;
} elseif (isset($subRecord->isoCode)) {
$area->code = $subRecord->isoCode;
}
if ($area->type != 'continent') {
$parent_area = $get_parent_area($area->type);
$area->parent_id = $parent_area->id;
}
$area->save();
// save name and translations
foreach ($subRecord->names as $lang => $name) {
$n = new GeoAreaName();
$n->area_id = $area->id;
$n->language = $lang;
$n->name = $name;
$n->save();
}
return $area;
};
$area = $get_area($record, 'city');
$this->geo_area_id = $area->id;
} catch (\Exception $e) {
// geo lookup might fail, but that's not grave
}
return $this;
}