defmodule PlausibleWeb.AuthController do
use PlausibleWeb , :controller
use Plausible.Repo
alias Plausible.Auth
require Logger
plug (
PlausibleWeb.RequireLoggedOutPlug
when action in [
:register ,
:register_from_invitation ,
:login_form ,
:login
]
)
plug (
PlausibleWeb.RequireAccountPlug
when action in [
:user_settings ,
:save_settings ,
:update_email ,
:cancel_update_email ,
:new_api_key ,
:create_api_key ,
:delete_api_key ,
:delete_me ,
:activate_form ,
:activate ,
:request_activation_code
]
)
plug ( :assign_is_selfhost )
defp assign_is_selfhost ( conn , _opts ) do
assign ( conn , :is_selfhost , Plausible.Release . selfhost? ( ) )
end
def register ( conn , %{ " user " = > %{ " email " = > email , " password " = > password } } ) do
with { :ok , user } <- login_user ( conn , email , password ) do
conn = set_user_session ( conn , user )
if user . email_verified do
redirect ( conn , to : Routes . site_path ( conn , :new ) )
else
Auth.EmailVerification . issue_code ( user )
redirect ( conn , to : Routes . auth_path ( conn , :activate_form ) )
end
end
end
def register_from_invitation ( conn , %{ " user " = > %{ " email " = > email , " password " = > password } } ) do
with { :ok , user } <- login_user ( conn , email , password ) do
conn = set_user_session ( conn , user )
if user . email_verified do
redirect ( conn , to : Routes . site_path ( conn , :index ) )
else
Auth.EmailVerification . issue_code ( user )
redirect ( conn , to : Routes . auth_path ( conn , :activate_form ) )
end
end
end
def activate_form ( conn , _params ) do
user = conn . assigns . current_user
render ( conn , " activate.html " ,
has_email_code? : Plausible.Users . has_email_code? ( user ) ,
has_any_invitations? : Plausible.Site.Memberships . pending? ( user . email ) ,
has_any_memberships? : Plausible.Site.Memberships . any? ( user ) ,
layout : { PlausibleWeb.LayoutView , " focus.html " }
)
end
def activate ( conn , %{ " code " = > code } ) do
user = conn . assigns [ :current_user ]
has_any_invitations? = Plausible.Site.Memberships . pending? ( user . email )
has_any_memberships? = Plausible.Site.Memberships . any? ( user )
case Auth.EmailVerification . verify_code ( user , code ) do
:ok ->
cond do
has_any_memberships? ->
handle_email_updated ( conn )
has_any_invitations? ->
redirect ( conn , to : Routes . site_path ( conn , :index ) )
true ->
redirect ( conn , to : Routes . site_path ( conn , :new ) )
end
{ :error , :incorrect } ->
render ( conn , " activate.html " ,
error : " Incorrect activation code " ,
has_email_code? : true ,
has_any_invitations? : has_any_invitations? ,
has_any_memberships? : has_any_memberships? ,
layout : { PlausibleWeb.LayoutView , " focus.html " }
)
{ :error , :expired } ->
render ( conn , " activate.html " ,
error : " Code is expired, please request another one " ,
has_email_code? : false ,
has_any_invitations? : has_any_invitations? ,
has_any_memberships? : has_any_memberships? ,
layout : { PlausibleWeb.LayoutView , " focus.html " }
)
end
end
def request_activation_code ( conn , _params ) do
user = conn . assigns . current_user
Auth.EmailVerification . issue_code ( user )
conn
|> put_flash ( :success , " Activation code was sent to #{ user . email } " )
|> redirect ( to : Routes . auth_path ( conn , :activate_form ) )
end
def password_reset_request_form ( conn , _ ) do
render ( conn , " password_reset_request_form.html " ,
layout : { PlausibleWeb.LayoutView , " focus.html " }
)
end
def password_reset_request ( conn , %{ " email " = > " " } ) do
render ( conn , " password_reset_request_form.html " ,
error : " Please enter an email address " ,
layout : { PlausibleWeb.LayoutView , " focus.html " }
)
end
def password_reset_request ( conn , %{ " email " = > email } = params ) do
if PlausibleWeb.Captcha . verify ( params [ " h-captcha-response " ] ) do
user = Repo . get_by ( Plausible.Auth.User , email : email )
if user do
token = Auth.Token . sign_password_reset ( email )
url = PlausibleWeb.Endpoint . url ( ) <> " /password/reset?token= #{ token } "
email_template = PlausibleWeb.Email . password_reset_email ( email , url )
Plausible.Mailer . deliver_later ( email_template )
Logger . debug (
" Password reset e-mail sent. In dev environment GET /sent-emails for details. "
)
render ( conn , " password_reset_request_success.html " ,
email : email ,
layout : { PlausibleWeb.LayoutView , " focus.html " }
)
else
render ( conn , " password_reset_request_success.html " ,
email : email ,
layout : { PlausibleWeb.LayoutView , " focus.html " }
)
end
else
render ( conn , " password_reset_request_form.html " ,
error : " Please complete the captcha to reset your password " ,
layout : { PlausibleWeb.LayoutView , " focus.html " }
)
end
end
def password_reset_form ( conn , params ) do
case Auth.Token . verify_password_reset ( params [ " token " ] ) do
{ :ok , %{ email : email } } ->
render ( conn , " password_reset_form.html " ,
connect_live_socket : true ,
email : email ,
layout : { PlausibleWeb.LayoutView , " focus.html " }
)
{ :error , :expired } ->
render_error (
conn ,
401 ,
" Your token has expired. Please request another password reset link. "
)
{ :error , _ } ->
render_error (
conn ,
401 ,
" Your token is invalid. Please request another password reset link. "
)
end
end
def password_reset ( conn , _params ) do
conn
|> put_flash ( :login_title , " Password updated successfully " )
|> put_flash ( :login_instructions , " Please log in with your new credentials " )
|> put_session ( :current_user_id , nil )
|> delete_resp_cookie ( " logged_in " )
|> redirect ( to : Routes . auth_path ( conn , :login_form ) )
end
def login ( conn , %{ " email " = > email , " password " = > password } ) do
with { :ok , user } <- login_user ( conn , email , password ) do
login_dest = get_session ( conn , :login_dest ) || Routes . site_path ( conn , :index )
conn
|> set_user_session ( user )
|> put_session ( :login_dest , nil )
|> redirect ( to : login_dest )
end
end
defp login_user ( conn , email , password ) do
with :ok <- check_ip_rate_limit ( conn ) ,
{ :ok , user } <- find_user ( email ) ,
:ok <- check_user_rate_limit ( user ) ,
:ok <- check_password ( user , password ) do
{ :ok , user }
else
:wrong_password ->
maybe_log_failed_login_attempts ( " wrong password for #{ email } " )
render ( conn , " login_form.html " ,
error : " Wrong email or password. Please try again. " ,
layout : { PlausibleWeb.LayoutView , " focus.html " }
)
:user_not_found ->
maybe_log_failed_login_attempts ( " user not found for #{ email } " )
Plausible.Auth.Password . dummy_calculation ( )
render ( conn , " login_form.html " ,
error : " Wrong email or password. Please try again. " ,
layout : { PlausibleWeb.LayoutView , " focus.html " }
)
{ :rate_limit , _ } ->
maybe_log_failed_login_attempts ( " too many logging attempts for #{ email } " )
render_error (
conn ,
429 ,
" Too many login attempts. Wait a minute before trying again. "
)
end
end
defp set_user_session ( conn , user ) do
conn
|> put_session ( :current_user_id , user . id )
|> put_resp_cookie ( " logged_in " , " true " ,
http_only : false ,
max_age : 60 * 60 * 24 * 365 * 5000
)
end
defp maybe_log_failed_login_attempts ( message ) do
if Application . get_env ( :plausible , :log_failed_login_attempts ) do
Logger . warning ( " [login] #{ message } " )
end
end
@login_interval 60_000
@login_limit 5
defp check_ip_rate_limit ( conn ) do
ip_address = PlausibleWeb.RemoteIp . get ( conn )
case Hammer . check_rate ( " login:ip: #{ ip_address } " , @login_interval , @login_limit ) do
{ :allow , _ } -> :ok
{ :deny , _ } -> { :rate_limit , :ip_address }
end
end
defp find_user ( email ) do
user =
Repo . one (
from ( u in Plausible.Auth.User ,
where : u . email == ^ email
)
)
if user , do : { :ok , user } , else : :user_not_found
end
defp check_user_rate_limit ( user ) do
case Hammer . check_rate ( " login:user: #{ user . id } " , @login_interval , @login_limit ) do
{ :allow , _ } -> :ok
{ :deny , _ } -> { :rate_limit , :user }
end
end
defp check_password ( user , password ) do
if Plausible.Auth.Password . match? ( password , user . password_hash || " " ) do
:ok
else
:wrong_password
end
end
def login_form ( conn , _params ) do
render ( conn , " login_form.html " , layout : { PlausibleWeb.LayoutView , " focus.html " } )
end
def user_settings ( conn , _params ) do
settings_changeset = Auth.User . settings_changeset ( conn . assigns [ :current_user ] )
email_changeset = Auth.User . settings_changeset ( conn . assigns [ :current_user ] )
render_settings ( conn ,
settings_changeset : settings_changeset ,
email_changeset : email_changeset
)
end
def save_settings ( conn , %{ " user " = > user_params } ) do
changes = Auth.User . settings_changeset ( conn . assigns [ :current_user ] , user_params )
case Repo . update ( changes ) do
{ :ok , _user } ->
conn
|> put_flash ( :success , " Account settings saved successfully " )
|> redirect ( to : Routes . auth_path ( conn , :user_settings ) )
{ :error , changeset } ->
email_changeset = Auth.User . settings_changeset ( conn . assigns [ :current_user ] )
render_settings ( conn , settings_changeset : changeset , email_changeset : email_changeset )
end
end
def update_email ( conn , %{ " user " = > user_params } ) do
changes = Auth.User . email_changeset ( conn . assigns [ :current_user ] , user_params )
case Repo . update ( changes ) do
{ :ok , user } ->
if user . email_verified do
handle_email_updated ( conn )
else
Auth.EmailVerification . issue_code ( user )
redirect ( conn , to : Routes . auth_path ( conn , :activate_form ) )
end
{ :error , changeset } ->
settings_changeset = Auth.User . settings_changeset ( conn . assigns [ :current_user ] )
render_settings ( conn , settings_changeset : settings_changeset , email_changeset : changeset )
end
end
def cancel_update_email ( conn , _params ) do
changeset = Auth.User . cancel_email_changeset ( conn . assigns . current_user )
case Repo . update ( changeset ) do
{ :ok , user } ->
conn
|> put_flash ( :success , " Email changed back to #{ user . email } " )
|> redirect ( to : Routes . auth_path ( conn , :user_settings ) <> " # change-email-address " )
{ :error , _ } ->
conn
|> put_flash (
:error ,
" Could not cancel email update because previous email has already been taken "
)
|> redirect ( to : Routes . auth_path ( conn , :activate_form ) )
end
end
defp handle_email_updated ( conn ) do
conn
|> put_flash ( :success , " Email updated successfully " )
|> redirect ( to : Routes . auth_path ( conn , :user_settings ) <> " # change-email-address " )
end
defp render_settings ( conn , opts ) do
settings_changeset = Keyword . fetch! ( opts , :settings_changeset )
email_changeset = Keyword . fetch! ( opts , :email_changeset )
user = Plausible.Users . with_subscription ( conn . assigns [ :current_user ] )
{ pageview_usage , custom_event_usage } = Plausible.Billing . usage_breakdown ( user )
render ( conn , " user_settings.html " ,
user : user |> Repo . preload ( :api_keys ) ,
settings_changeset : settings_changeset ,
email_changeset : email_changeset ,
subscription : user . subscription ,
invoices : Plausible.Billing . paddle_api ( ) . get_invoices ( user . subscription ) ,
theme : user . theme || " system " ,
team_member_limit : Plausible.Billing.Quota . team_member_limit ( user ) ,
team_member_usage : Plausible.Billing.Quota . team_member_usage ( user ) ,
site_limit : Plausible.Billing.Quota . site_limit ( user ) ,
site_usage : Plausible.Billing.Quota . site_usage ( user ) ,
total_pageview_limit : Plausible.Billing.Quota . monthly_pageview_limit ( user . subscription ) ,
total_pageview_usage : pageview_usage + custom_event_usage ,
custom_event_usage : custom_event_usage ,
pageview_usage : pageview_usage
)
end
def new_api_key ( conn , _params ) do
changeset = Auth.ApiKey . changeset ( % Auth.ApiKey { } )
render ( conn , " new_api_key.html " ,
changeset : changeset ,
layout : { PlausibleWeb.LayoutView , " focus.html " }
)
end
def create_api_key ( conn , %{ " api_key " = > %{ " name " = > name , " key " = > key } } ) do
case Auth . create_api_key ( conn . assigns . current_user , name , key ) do
{ :ok , _api_key } ->
conn
|> put_flash ( :success , " API key created successfully " )
|> redirect ( to : " /settings # api-keys " )
{ :error , changeset } ->
render ( conn , " new_api_key.html " ,
changeset : changeset ,
layout : { PlausibleWeb.LayoutView , " focus.html " }
)
end
end
def delete_api_key ( conn , %{ " id " = > id } ) do
case Auth . delete_api_key ( conn . assigns . current_user , id ) do
:ok ->
conn
|> put_flash ( :success , " API key revoked successfully " )
|> redirect ( to : " /settings # api-keys " )
{ :error , :not_found } ->
conn
|> put_flash ( :error , " Could not find API Key to delete " )
|> redirect ( to : " /settings # api-keys " )
end
end
def delete_me ( conn , params ) do
Plausible.Auth . delete_user ( conn . assigns [ :current_user ] )
logout ( conn , params )
end
def logout ( conn , params ) do
redirect_to = Map . get ( params , " redirect " , " / " )
conn
|> configure_session ( drop : true )
|> delete_resp_cookie ( " logged_in " )
|> redirect ( to : redirect_to )
end
def google_auth_callback ( conn , %{ " error " = > error , " state " = > state } = params ) do
[ site_id , _redirect_to ] = Jason . decode! ( state )
site = Repo . get ( Plausible.Site , site_id )
case error do
" access_denied " ->
conn
|> put_flash (
:error ,
" We were unable to authenticate your Google Analytics account. Please check that you have granted us permission to 'See and download your Google Analytics data' and try again. "
)
|> redirect ( to : Routes . site_path ( conn , :settings_general , site . domain ) )
message when message in [ " server_error " , " temporarily_unavailable " ] ->
conn
|> put_flash (
:error ,
" We are unable to authenticate your Google Analytics account because Google's authentication service is temporarily unavailable. Please try again in a few moments. "
)
|> redirect ( to : Routes . site_path ( conn , :settings_general , site . domain ) )
_any ->
Sentry . capture_message ( " Google OAuth callback failed. Reason: #{ inspect ( params ) } " )
conn
|> put_flash (
:error ,
" We were unable to authenticate your Google Analytics account. If the problem persists, please contact support for assistance. "
)
|> redirect ( to : Routes . site_path ( conn , :settings_general , site . domain ) )
end
end
[Continued] Google Analytics import (#1753)
* Add has_imported_stats boolean to Site
* Add Google Analytics import panel to general settings
* Get GA profiles to display in import settings panel
* Add import_from_google method as entrypoint to import data
* Add imported_visitors table
* Remove conflicting code from migration
* Import visitors data into clickhouse database
* Pass another dataset to main graph for rendering in red
This adds another entry to the JSON data returned via the main graph API
called `imported_plot`, which is similar to `plot` in form but will be
completed with previously imported data. Currently it simply returns
the values from `plot` / 2. The data is rendered in the main graph in
red without fill, and without an indicator for the present. Rationale:
imported data will not continue to grow so there is no projection
forward, only backwards.
* Hook imported GA data to dashboard timeseries plot
* Add settings option to forget imported data
* Import sources from google analytics
* Merge imported sources when queried
* Merge imported source data native data when querying sources
* Start converting metrics to atoms so they can be subqueried
This changes "visitors" and in some places "sources" to atoms. This does
not change the behaviour of the functions - the tests all pass unchanged
following this commit. This is necessary as joining subqueries requires
that the keys in `select` statements be atoms and not strings.
* Convery GA (direct) source to empty string
* Import utm campaign and utm medium from GA
* format
* Import all data types from GA into new tables
* Handle large amounts of more data more safely
* Fix some mistakes in tables
* Make GA requests in chunks of 5 queries
* Only display imported timeseries when there is no filter
* Correctly show last 30 minutes timeseries when 'realtime'
* Add with_imported key to Query struct
* Account for injected :is_not filter on sources from dashboard
* Also add tentative imported_utm_sources table
This needs a bit more work on the google import side, as GA do not
report sources and utm sources as distinct things.
* Return imported data to dashboard for rest of Sources panel
This extends the merge_imported function definition for sources to
utm_sources, utm_mediums and utm_campaigns too. This appears to be
working on the DB side but something is incomplete on the client side.
* Clear imported stats from all tables when requested
* Merge entry pages and exit pages from imported data into unfiltered dashboard view
This requires converting the `"visits"` and `"visit_duration"` metrics
to atoms so that they can be used in ecto subqueries.
* Display imported devices, browsers and OSs on dashboard
* Display imported country data on dashboard
* Add more metrics to entries/exits for modals
* make sure data is returned via API with correct keys
* Import regions and cities from GA
* Capitalize device upon import to match native data
* Leave query limits/offsets until after possibly joining with imported data
* Also import timeOnPage and pageviews for pages from GA
* imported_countries -> imported_locations
* Get timeOnPage and pageviews for pages from GA
These are needed for the pages modal, and for calculating exit rates for
exit pages.
* Add indicator to dashboard when imported data is being used
* Don't show imported data as separately line on main graph
* "bounce_rate" -> :bounce_rate, so it works in subqueries
* Drop imported browser and OS versions
These are not needed.
* Toggle displaying imported data by clicking indicator
* Parse referrers with RefInspector
- Use 'ga:fullReferrer' instead of 'ga:source'. This provides the actual
referrer host + path, whereas 'ga:source' includes utm_mediums and
other values when relevant.
- 'ga:fullReferror' does however include search engine names directly,
so they are manually checked for as RefInspector won't pick up on
these.
* Keep imported data indicator on dashboard and strikethrough when hidden
* Add unlink google button to import panel
* Rename some GA browsers and OSes to plausible versions
* Get main top pages and exit pages panels working correctly with imported data
* mix format
* Fetch time_on_pages for imported data when needed
* entry pages need to fetch bounces from GA
* "sample_percent" -> :sample_percent as only atoms can be used in subqueries
* Calculate bounce_rate for joined native and imported data for top pages modal
* Flip some query bindings around to be less misleading
* Fixup entry page modal visit durations
* mix format
* Fetch bounces and visit_duration for sources from GA
* add more source metrics used for data in modals
* Make sources modals display correct values
* imported_visitors: bounce_rate -> bounces, avg_visit_duration -> visit_duration
* Merge imported data into aggregate stats
* Reformat top graph side icons
* Ensure sample_percent is yielded from aggregate data
* filter event_props should be strings
* Hide imported data from frontend when using filter
* Fix existing tests
* fix tests
* Fix imported indicator appearing when filtering
* comma needed, lost when rebasing
* Import utm_terms and utm_content from GA
* Merge imported utm_term and utm_content
* Rename imported Countries data as Locations
* Set imported city schema field to int
* Remove utm_terms and utm_content when clearing imported
* Clean locations import from Google Analytics
- Country and region should be set to "" when GA provides "(not set)"
- City should be set to 0 for "unknown", as we cannot reliably import
city data from GA.
* Display imported region and city in dashboard
* os -> operating_system in some parts of code
The inconsistency of using os in some places and operating_system in
others causes trouble with subqueries and joins for the native and
imported data, which would require additional logic to account for. The
simplest solution is the just use a consistent word for all uses. This
doesn't make any user-facing or database changes.
* to_atom -> to_existing_atom
* format
* "events" metric -> :events
* ignore imported data when "events" in metrics
* update "bounce_rate"
* atomise some more metrics from new city and region api
* atomise some more metrics for email handlers
* "conversion_rate" -> :conversion_rate during csv export
* Move imported data stats code to own module
* Move imported timeseries function to Stats.Imported
* Use Timex.parse to import dates from GA
* has_imported_stats -> imported_source
* "time_on_page" -> :time_on_page
* Convert imported GA data to UTC
* Clean up GA request code a bit
There was some weird logic here with two separate lists that really
ought to be together, so this merges those.
* Fail sooner if GA timezone can't be identified
* Link imported tables to site by id
* imported_utm_content -> imported_utm_contents
* Imported GA from all of time
* Reorganise GA data fetch logic
- Fetch data from the start of time (2005)
- Check whether no data was fetched, and if so, inform user and don't
consider data to be imported.
* Clarify removal of "visits" data when it isn't in metrics
* Apply location filters from API
This makes it consistent with the sources etc which filter out 'Direct /
None' on the API side. These filters are used by both the native and
imported data handling code, which would otherwise both duplicate the
filters in their `where` clauses.
* Do not use changeset for setting site.imported_source
* Add all metrics to all dimensions
* Run GA import in the background
* Send email when GA import completes
* Add handler to insert imported data into tests and imported_browsers_factory
* Add remaining import data test factories
* Add imported location data to test
* Test main graph with imported data
* Add imported data to operating systems tests
* Add imported data to pages tests
* Add imported data to entry pages tests
* Add imported data to exit pages tests
* Add imported data to devices tests
* Add imported data to sources tests
* Add imported data to UTM tests
* Add new test module for the data import step
* Test import of sources GA data
* Test import of utm_mediums GA data
* Test import of utm_campaigns GA data
* Add tests for UTM terms
* Add tests for UTM contents
* Add test for importing pages and entry pages data from GA
* Add test for importing exit page data
* Fix module file name typo
* Add test for importing location data from GA
* Add test for importing devices data from GA
* Add test for importing browsers data from GA
* Add test for importing OS data from GA
* Paginate GA requests to download all data
* Bump clickhouse_ecto version
* Move RefInspector wrapper function into module
* Drop timezone transform on import
* Order imported by side_id then date
* More strings -> atoms
Also changes a conditional to be a bit nicer
* Remove parallelisation of data import
* Split sources and UTM sources from fetched GA data
GA has only a "source" dimension and no "UTM source" dimension. Instead
it returns these combined. The logic herein to tease these apart is:
1. "(direct)" -> it's a direct source
2. if the source is a domain -> it's a source
3. "google" -> it's from adwords; let's make this a UTM source "adwords"
4. else -> just a UTM source
* Keep prop names in queries as strings
* fix typo
* Fix import
* Insert data to clickhouse in batches
* Fix link when removing imported data
* Merge source tables
* Import hostname as well as pathname
* Record start and end time of imported data
* Track import progress
* Fix month interval with imported data
* Do not JOIN when imported date range has no overlap
* Fix time on page using exits
Co-authored-by: mcol <mcol@posteo.net>
5 years ago
def google_auth_callback ( conn , %{ " code " = > code , " state " = > state } ) do
res = Plausible.Google.HTTP . fetch_access_token ( code )
[Continued] Google Analytics import (#1753)
* Add has_imported_stats boolean to Site
* Add Google Analytics import panel to general settings
* Get GA profiles to display in import settings panel
* Add import_from_google method as entrypoint to import data
* Add imported_visitors table
* Remove conflicting code from migration
* Import visitors data into clickhouse database
* Pass another dataset to main graph for rendering in red
This adds another entry to the JSON data returned via the main graph API
called `imported_plot`, which is similar to `plot` in form but will be
completed with previously imported data. Currently it simply returns
the values from `plot` / 2. The data is rendered in the main graph in
red without fill, and without an indicator for the present. Rationale:
imported data will not continue to grow so there is no projection
forward, only backwards.
* Hook imported GA data to dashboard timeseries plot
* Add settings option to forget imported data
* Import sources from google analytics
* Merge imported sources when queried
* Merge imported source data native data when querying sources
* Start converting metrics to atoms so they can be subqueried
This changes "visitors" and in some places "sources" to atoms. This does
not change the behaviour of the functions - the tests all pass unchanged
following this commit. This is necessary as joining subqueries requires
that the keys in `select` statements be atoms and not strings.
* Convery GA (direct) source to empty string
* Import utm campaign and utm medium from GA
* format
* Import all data types from GA into new tables
* Handle large amounts of more data more safely
* Fix some mistakes in tables
* Make GA requests in chunks of 5 queries
* Only display imported timeseries when there is no filter
* Correctly show last 30 minutes timeseries when 'realtime'
* Add with_imported key to Query struct
* Account for injected :is_not filter on sources from dashboard
* Also add tentative imported_utm_sources table
This needs a bit more work on the google import side, as GA do not
report sources and utm sources as distinct things.
* Return imported data to dashboard for rest of Sources panel
This extends the merge_imported function definition for sources to
utm_sources, utm_mediums and utm_campaigns too. This appears to be
working on the DB side but something is incomplete on the client side.
* Clear imported stats from all tables when requested
* Merge entry pages and exit pages from imported data into unfiltered dashboard view
This requires converting the `"visits"` and `"visit_duration"` metrics
to atoms so that they can be used in ecto subqueries.
* Display imported devices, browsers and OSs on dashboard
* Display imported country data on dashboard
* Add more metrics to entries/exits for modals
* make sure data is returned via API with correct keys
* Import regions and cities from GA
* Capitalize device upon import to match native data
* Leave query limits/offsets until after possibly joining with imported data
* Also import timeOnPage and pageviews for pages from GA
* imported_countries -> imported_locations
* Get timeOnPage and pageviews for pages from GA
These are needed for the pages modal, and for calculating exit rates for
exit pages.
* Add indicator to dashboard when imported data is being used
* Don't show imported data as separately line on main graph
* "bounce_rate" -> :bounce_rate, so it works in subqueries
* Drop imported browser and OS versions
These are not needed.
* Toggle displaying imported data by clicking indicator
* Parse referrers with RefInspector
- Use 'ga:fullReferrer' instead of 'ga:source'. This provides the actual
referrer host + path, whereas 'ga:source' includes utm_mediums and
other values when relevant.
- 'ga:fullReferror' does however include search engine names directly,
so they are manually checked for as RefInspector won't pick up on
these.
* Keep imported data indicator on dashboard and strikethrough when hidden
* Add unlink google button to import panel
* Rename some GA browsers and OSes to plausible versions
* Get main top pages and exit pages panels working correctly with imported data
* mix format
* Fetch time_on_pages for imported data when needed
* entry pages need to fetch bounces from GA
* "sample_percent" -> :sample_percent as only atoms can be used in subqueries
* Calculate bounce_rate for joined native and imported data for top pages modal
* Flip some query bindings around to be less misleading
* Fixup entry page modal visit durations
* mix format
* Fetch bounces and visit_duration for sources from GA
* add more source metrics used for data in modals
* Make sources modals display correct values
* imported_visitors: bounce_rate -> bounces, avg_visit_duration -> visit_duration
* Merge imported data into aggregate stats
* Reformat top graph side icons
* Ensure sample_percent is yielded from aggregate data
* filter event_props should be strings
* Hide imported data from frontend when using filter
* Fix existing tests
* fix tests
* Fix imported indicator appearing when filtering
* comma needed, lost when rebasing
* Import utm_terms and utm_content from GA
* Merge imported utm_term and utm_content
* Rename imported Countries data as Locations
* Set imported city schema field to int
* Remove utm_terms and utm_content when clearing imported
* Clean locations import from Google Analytics
- Country and region should be set to "" when GA provides "(not set)"
- City should be set to 0 for "unknown", as we cannot reliably import
city data from GA.
* Display imported region and city in dashboard
* os -> operating_system in some parts of code
The inconsistency of using os in some places and operating_system in
others causes trouble with subqueries and joins for the native and
imported data, which would require additional logic to account for. The
simplest solution is the just use a consistent word for all uses. This
doesn't make any user-facing or database changes.
* to_atom -> to_existing_atom
* format
* "events" metric -> :events
* ignore imported data when "events" in metrics
* update "bounce_rate"
* atomise some more metrics from new city and region api
* atomise some more metrics for email handlers
* "conversion_rate" -> :conversion_rate during csv export
* Move imported data stats code to own module
* Move imported timeseries function to Stats.Imported
* Use Timex.parse to import dates from GA
* has_imported_stats -> imported_source
* "time_on_page" -> :time_on_page
* Convert imported GA data to UTC
* Clean up GA request code a bit
There was some weird logic here with two separate lists that really
ought to be together, so this merges those.
* Fail sooner if GA timezone can't be identified
* Link imported tables to site by id
* imported_utm_content -> imported_utm_contents
* Imported GA from all of time
* Reorganise GA data fetch logic
- Fetch data from the start of time (2005)
- Check whether no data was fetched, and if so, inform user and don't
consider data to be imported.
* Clarify removal of "visits" data when it isn't in metrics
* Apply location filters from API
This makes it consistent with the sources etc which filter out 'Direct /
None' on the API side. These filters are used by both the native and
imported data handling code, which would otherwise both duplicate the
filters in their `where` clauses.
* Do not use changeset for setting site.imported_source
* Add all metrics to all dimensions
* Run GA import in the background
* Send email when GA import completes
* Add handler to insert imported data into tests and imported_browsers_factory
* Add remaining import data test factories
* Add imported location data to test
* Test main graph with imported data
* Add imported data to operating systems tests
* Add imported data to pages tests
* Add imported data to entry pages tests
* Add imported data to exit pages tests
* Add imported data to devices tests
* Add imported data to sources tests
* Add imported data to UTM tests
* Add new test module for the data import step
* Test import of sources GA data
* Test import of utm_mediums GA data
* Test import of utm_campaigns GA data
* Add tests for UTM terms
* Add tests for UTM contents
* Add test for importing pages and entry pages data from GA
* Add test for importing exit page data
* Fix module file name typo
* Add test for importing location data from GA
* Add test for importing devices data from GA
* Add test for importing browsers data from GA
* Add test for importing OS data from GA
* Paginate GA requests to download all data
* Bump clickhouse_ecto version
* Move RefInspector wrapper function into module
* Drop timezone transform on import
* Order imported by side_id then date
* More strings -> atoms
Also changes a conditional to be a bit nicer
* Remove parallelisation of data import
* Split sources and UTM sources from fetched GA data
GA has only a "source" dimension and no "UTM source" dimension. Instead
it returns these combined. The logic herein to tease these apart is:
1. "(direct)" -> it's a direct source
2. if the source is a domain -> it's a source
3. "google" -> it's from adwords; let's make this a UTM source "adwords"
4. else -> just a UTM source
* Keep prop names in queries as strings
* fix typo
* Fix import
* Insert data to clickhouse in batches
* Fix link when removing imported data
* Merge source tables
* Import hostname as well as pathname
* Record start and end time of imported data
* Track import progress
* Fix month interval with imported data
* Do not JOIN when imported date range has no overlap
* Fix time on page using exits
Co-authored-by: mcol <mcol@posteo.net>
5 years ago
[ site_id , redirect_to ] = Jason . decode! ( state )
site = Repo . get ( Plausible.Site , site_id )
expires_at = NaiveDateTime . add ( NaiveDateTime . utc_now ( ) , res [ " expires_in " ] )
case redirect_to do
" import " ->
redirect ( conn ,
to :
Routes . site_path ( conn , :import_from_google_view_id_form , site . domain ,
access_token : res [ " access_token " ] ,
refresh_token : res [ " refresh_token " ] ,
expires_at : NaiveDateTime . to_iso8601 ( expires_at )
)
)
[Continued] Google Analytics import (#1753)
* Add has_imported_stats boolean to Site
* Add Google Analytics import panel to general settings
* Get GA profiles to display in import settings panel
* Add import_from_google method as entrypoint to import data
* Add imported_visitors table
* Remove conflicting code from migration
* Import visitors data into clickhouse database
* Pass another dataset to main graph for rendering in red
This adds another entry to the JSON data returned via the main graph API
called `imported_plot`, which is similar to `plot` in form but will be
completed with previously imported data. Currently it simply returns
the values from `plot` / 2. The data is rendered in the main graph in
red without fill, and without an indicator for the present. Rationale:
imported data will not continue to grow so there is no projection
forward, only backwards.
* Hook imported GA data to dashboard timeseries plot
* Add settings option to forget imported data
* Import sources from google analytics
* Merge imported sources when queried
* Merge imported source data native data when querying sources
* Start converting metrics to atoms so they can be subqueried
This changes "visitors" and in some places "sources" to atoms. This does
not change the behaviour of the functions - the tests all pass unchanged
following this commit. This is necessary as joining subqueries requires
that the keys in `select` statements be atoms and not strings.
* Convery GA (direct) source to empty string
* Import utm campaign and utm medium from GA
* format
* Import all data types from GA into new tables
* Handle large amounts of more data more safely
* Fix some mistakes in tables
* Make GA requests in chunks of 5 queries
* Only display imported timeseries when there is no filter
* Correctly show last 30 minutes timeseries when 'realtime'
* Add with_imported key to Query struct
* Account for injected :is_not filter on sources from dashboard
* Also add tentative imported_utm_sources table
This needs a bit more work on the google import side, as GA do not
report sources and utm sources as distinct things.
* Return imported data to dashboard for rest of Sources panel
This extends the merge_imported function definition for sources to
utm_sources, utm_mediums and utm_campaigns too. This appears to be
working on the DB side but something is incomplete on the client side.
* Clear imported stats from all tables when requested
* Merge entry pages and exit pages from imported data into unfiltered dashboard view
This requires converting the `"visits"` and `"visit_duration"` metrics
to atoms so that they can be used in ecto subqueries.
* Display imported devices, browsers and OSs on dashboard
* Display imported country data on dashboard
* Add more metrics to entries/exits for modals
* make sure data is returned via API with correct keys
* Import regions and cities from GA
* Capitalize device upon import to match native data
* Leave query limits/offsets until after possibly joining with imported data
* Also import timeOnPage and pageviews for pages from GA
* imported_countries -> imported_locations
* Get timeOnPage and pageviews for pages from GA
These are needed for the pages modal, and for calculating exit rates for
exit pages.
* Add indicator to dashboard when imported data is being used
* Don't show imported data as separately line on main graph
* "bounce_rate" -> :bounce_rate, so it works in subqueries
* Drop imported browser and OS versions
These are not needed.
* Toggle displaying imported data by clicking indicator
* Parse referrers with RefInspector
- Use 'ga:fullReferrer' instead of 'ga:source'. This provides the actual
referrer host + path, whereas 'ga:source' includes utm_mediums and
other values when relevant.
- 'ga:fullReferror' does however include search engine names directly,
so they are manually checked for as RefInspector won't pick up on
these.
* Keep imported data indicator on dashboard and strikethrough when hidden
* Add unlink google button to import panel
* Rename some GA browsers and OSes to plausible versions
* Get main top pages and exit pages panels working correctly with imported data
* mix format
* Fetch time_on_pages for imported data when needed
* entry pages need to fetch bounces from GA
* "sample_percent" -> :sample_percent as only atoms can be used in subqueries
* Calculate bounce_rate for joined native and imported data for top pages modal
* Flip some query bindings around to be less misleading
* Fixup entry page modal visit durations
* mix format
* Fetch bounces and visit_duration for sources from GA
* add more source metrics used for data in modals
* Make sources modals display correct values
* imported_visitors: bounce_rate -> bounces, avg_visit_duration -> visit_duration
* Merge imported data into aggregate stats
* Reformat top graph side icons
* Ensure sample_percent is yielded from aggregate data
* filter event_props should be strings
* Hide imported data from frontend when using filter
* Fix existing tests
* fix tests
* Fix imported indicator appearing when filtering
* comma needed, lost when rebasing
* Import utm_terms and utm_content from GA
* Merge imported utm_term and utm_content
* Rename imported Countries data as Locations
* Set imported city schema field to int
* Remove utm_terms and utm_content when clearing imported
* Clean locations import from Google Analytics
- Country and region should be set to "" when GA provides "(not set)"
- City should be set to 0 for "unknown", as we cannot reliably import
city data from GA.
* Display imported region and city in dashboard
* os -> operating_system in some parts of code
The inconsistency of using os in some places and operating_system in
others causes trouble with subqueries and joins for the native and
imported data, which would require additional logic to account for. The
simplest solution is the just use a consistent word for all uses. This
doesn't make any user-facing or database changes.
* to_atom -> to_existing_atom
* format
* "events" metric -> :events
* ignore imported data when "events" in metrics
* update "bounce_rate"
* atomise some more metrics from new city and region api
* atomise some more metrics for email handlers
* "conversion_rate" -> :conversion_rate during csv export
* Move imported data stats code to own module
* Move imported timeseries function to Stats.Imported
* Use Timex.parse to import dates from GA
* has_imported_stats -> imported_source
* "time_on_page" -> :time_on_page
* Convert imported GA data to UTC
* Clean up GA request code a bit
There was some weird logic here with two separate lists that really
ought to be together, so this merges those.
* Fail sooner if GA timezone can't be identified
* Link imported tables to site by id
* imported_utm_content -> imported_utm_contents
* Imported GA from all of time
* Reorganise GA data fetch logic
- Fetch data from the start of time (2005)
- Check whether no data was fetched, and if so, inform user and don't
consider data to be imported.
* Clarify removal of "visits" data when it isn't in metrics
* Apply location filters from API
This makes it consistent with the sources etc which filter out 'Direct /
None' on the API side. These filters are used by both the native and
imported data handling code, which would otherwise both duplicate the
filters in their `where` clauses.
* Do not use changeset for setting site.imported_source
* Add all metrics to all dimensions
* Run GA import in the background
* Send email when GA import completes
* Add handler to insert imported data into tests and imported_browsers_factory
* Add remaining import data test factories
* Add imported location data to test
* Test main graph with imported data
* Add imported data to operating systems tests
* Add imported data to pages tests
* Add imported data to entry pages tests
* Add imported data to exit pages tests
* Add imported data to devices tests
* Add imported data to sources tests
* Add imported data to UTM tests
* Add new test module for the data import step
* Test import of sources GA data
* Test import of utm_mediums GA data
* Test import of utm_campaigns GA data
* Add tests for UTM terms
* Add tests for UTM contents
* Add test for importing pages and entry pages data from GA
* Add test for importing exit page data
* Fix module file name typo
* Add test for importing location data from GA
* Add test for importing devices data from GA
* Add test for importing browsers data from GA
* Add test for importing OS data from GA
* Paginate GA requests to download all data
* Bump clickhouse_ecto version
* Move RefInspector wrapper function into module
* Drop timezone transform on import
* Order imported by side_id then date
* More strings -> atoms
Also changes a conditional to be a bit nicer
* Remove parallelisation of data import
* Split sources and UTM sources from fetched GA data
GA has only a "source" dimension and no "UTM source" dimension. Instead
it returns these combined. The logic herein to tease these apart is:
1. "(direct)" -> it's a direct source
2. if the source is a domain -> it's a source
3. "google" -> it's from adwords; let's make this a UTM source "adwords"
4. else -> just a UTM source
* Keep prop names in queries as strings
* fix typo
* Fix import
* Insert data to clickhouse in batches
* Fix link when removing imported data
* Merge source tables
* Import hostname as well as pathname
* Record start and end time of imported data
* Track import progress
* Fix month interval with imported data
* Do not JOIN when imported date range has no overlap
* Fix time on page using exits
Co-authored-by: mcol <mcol@posteo.net>
5 years ago
_ ->
id_token = res [ " id_token " ]
[ _ , body , _ ] = String . split ( id_token , " . " )
id = body |> Base . decode64! ( padding : false ) |> Jason . decode! ( )
Plausible.Site.GoogleAuth . changeset ( % Plausible.Site.GoogleAuth { } , %{
email : id [ " email " ] ,
refresh_token : res [ " refresh_token " ] ,
access_token : res [ " access_token " ] ,
expires : expires_at ,
user_id : conn . assigns [ :current_user ] . id ,
site_id : site_id
} )
|> Repo . insert! ( )
site = Repo . get ( Plausible.Site , site_id )
redirect ( conn , to : " / #{ URI . encode_www_form ( site . domain ) } /settings/integrations " )
end
end
end