aboutsummaryrefslogtreecommitdiff
path: root/src/main/java/org/traccar/helper/LogAction.java
blob: adbe3391673b4cdb6d28b81d15a72a00b45105a7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
/*
 * Copyright 2017 - 2020 Anton Tananaev (anton@traccar.org)
 * Copyright 2017 Andrey Kunitsyn (andrey@traccar.org)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.traccar.helper;

import java.beans.Introspector;
import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.List;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.traccar.model.BaseModel;

public final class LogAction {

    private static final Logger LOGGER = LoggerFactory.getLogger(LogAction.class);

    private LogAction() {
    }

    private static final String ACTION_CREATE = "create";
    private static final String ACTION_EDIT = "edit";
    private static final String ACTION_REMOVE = "remove";

    private static final String ACTION_LINK = "link";
    private static final String ACTION_UNLINK = "unlink";

    private static final String ACTION_LOGIN = "login";
    private static final String ACTION_LOGOUT = "logout";

    private static final String ACTION_ACCUMULATORS = "accumulators";

    private static final String PATTERN_OBJECT = "user: %d, action: %s, object: %s, id: %d";
    private static final String PATTERN_LINK = "user: %d, action: %s, owner: %s, id: %d, property: %s, id: %d";
    private static final String PATTERN_LOGIN = "user: %d, action: %s, from: %s";
    private static final String PATTERN_LOGIN_FAILED = "login failed from: %s";
    private static final String PATTERN_ACCUMULATORS = "user: %d, action: %s, deviceId: %d";
    private static final String PATTERN_REPORT = "user: %d, %s: %s, from: %s, to: %s, devices: %s, groups: %s";

    public static void create(long userId, BaseModel object) {
        logObjectAction(ACTION_CREATE, userId, object.getClass(), object.getId());
    }

    public static void edit(long userId, BaseModel object) {
        logObjectAction(ACTION_EDIT, userId, object.getClass(), object.getId());
    }

    public static void remove(long userId, Class<?> clazz, long objectId) {
        logObjectAction(ACTION_REMOVE, userId, clazz, objectId);
    }

    public static void link(long userId, Class<?> owner, long ownerId, Class<?> property, long propertyId) {
        logLinkAction(ACTION_LINK, userId, owner, ownerId, property, propertyId);
    }

    public static void unlink(long userId, Class<?> owner, long ownerId, Class<?> property, long propertyId) {
        logLinkAction(ACTION_UNLINK, userId, owner, ownerId, property, propertyId);
    }

    public static void login(long userId, String remoteAddress) {
        logLoginAction(ACTION_LOGIN, userId, remoteAddress);
    }

    public static void logout(long userId, String remoteAddress) {
        logLoginAction(ACTION_LOGOUT, userId, remoteAddress);
    }

    public static void failedLogin(String remoteAddress) {
        if (remoteAddress == null || remoteAddress.isEmpty()) {
            remoteAddress = "unknown";
        }
        LOGGER.info(String.format(PATTERN_LOGIN_FAILED, remoteAddress));
    }

    public static void resetAccumulators(long userId, long deviceId) {
        LOGGER.info(String.format(
                PATTERN_ACCUMULATORS, userId, ACTION_ACCUMULATORS, deviceId));
    }

    private static void logObjectAction(String action, long userId, Class<?> clazz, long objectId) {
        LOGGER.info(String.format(
                PATTERN_OBJECT, userId, action, Introspector.decapitalize(clazz.getSimpleName()), objectId));
    }

    private static void logLinkAction(
            String action, long userId, Class<?> owner, long ownerId, Class<?> property, long propertyId) {
        LOGGER.info(String.format(
                PATTERN_LINK, userId, action,
                Introspector.decapitalize(owner.getSimpleName()), ownerId,
                Introspector.decapitalize(property.getSimpleName()), propertyId));
    }

    private static void logLoginAction(String action, long userId, String remoteAddress) {
        if (remoteAddress == null || remoteAddress.isEmpty()) {
            remoteAddress = "unknown";
        }
        LOGGER.info(String.format(PATTERN_LOGIN, userId, action, remoteAddress));
    }

    public static void logReport(
            long userId, boolean scheduled, String report,
            Date from, Date to, List<Long> deviceIds, List<Long> groupIds) {
        DateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm");
        LOGGER.info(String.format(
                PATTERN_REPORT, userId, scheduled ? "scheduled" : "report", report,
                dateFormat.format(from), dateFormat.format(to),
                deviceIds.toString(), groupIds.toString()));
    }

}